Skip to content

IceHugh/zincsearch-node

Repository files navigation

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

[email protected]

(back to top)

About

node sdk for zincsearch with typescript and promise

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published