JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2
  • Score
    100M100P100Q34634F
  • License MIT

zincsearch sdk for node with promise

Package Exports

  • zincsearch-node
  • zincsearch-node/lib/index.cjs.js
  • zincsearch-node/lib/index.esm.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (zincsearch-node) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

About The Project

This use undici for http client;

(back to top)

Built With

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

  • node
    node >= 14

Installation

  1. npm
npm install zincsearch-node 
  1. yarn
yarn install zincsearch-node 
  1. pnpm
pnpm add zincsearch-node 

(back to top)

Usage

  1. import
  • es6
import ZincSearch from 'zincsearch-node';
  • require
const ZincSearch = require('zincsearch-node/lib/index.cjs')
  1. init
const zincSearch = new ZincSearch({
  url: /* zincsearch url */,
  user: /* zincsearch user  */,
  password: /* zincsearch password  */,
});
// check healthz
await zincSearch.healthz();
  1. more example see this wiki

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

ygz14836187@163.com

(back to top)