cnn007 / zincsearch-node

node sdk for zincsearch with typescript and promise

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 

2. yarn

yarn install zincsearch-node 

3. 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')

2. init

const zincSearch = new ZincSearch({
  url: /* zincsearch url */,
  user: /* zincsearch user  */,
  password: /* zincsearch password  */,
});
// check healthz
await zincSearch.healthz();

3. more example see this wiki

(back to top)

License

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

(back to top)

Contact

[e-mail]

(back to top)