npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

nacos

v2.6.0

Published

nacos client main package

Downloads

24,850

Readme

nacos-sdk-nodejs

NPM version build status David deps lerna

Nacos Node.js SDK

Install

npm install nacos --save

Version Mapping

Node.js SDK \ Nacos Server | 0.x.0 | 1.0.0 | --- | --- | --- | 1.x | √ | | 2.x | | √ |

Usage

Service Discovery

'use strict';

const NacosNamingClient = require('nacos').NacosNamingClient;
const logger = console;

const client = new NacosNamingClient({
  logger,
  serverList: '127.0.0.1:8848', // replace to real nacos serverList
  namespace: 'public',
});
await client.ready();

const serviceName = 'nodejs.test.domain';

// registry instance
await client.registerInstance(serviceName, {
  ip: '1.1.1.1',
  port: 8080,
});
await client.registerInstance(serviceName, {
  ip: '2.2.2.2',
  port: 8080,
});

// subscribe instance
client.subscribe(serviceName, hosts => {
  console.log(hosts);
});

// deregister instance
await client.deregisterInstance(serviceName, {
  ip: '1.1.1.1',
  port: 8080,
});

Config Service

import {NacosConfigClient} from 'nacos';   // ts
const NacosConfigClient = require('nacos').NacosConfigClient; // js

// for find address mode
const configClient = new NacosConfigClient({
  endpoint: 'acm.aliyun.com',
  namespace: '***************',
  accessKey: '***************',
  secretKey: '***************',
  requestTimeout: 6000,
});

// for direct mode
const configClient = new NacosConfigClient({
  serverAddr: '127.0.0.1:8848',
});

// get config once
const content= await configClient.getConfig('test', 'DEFAULT_GROUP');
console.log('getConfig = ',content);

// listen data changed
configClient.subscribe({
  dataId: 'test',
  group: 'DEFAULT_GROUP',
}, content => {
  console.log(content);
});

// publish config
const content= await configClient.publishSingle('test', 'DEFAULT_GROUP', '测试');
console.log('getConfig = ',content);

// remove config
await configClient.remove('test', 'DEFAULT_GROUP');

NacosConfigClient options: ClientOptions

default value: ClientOptions default value

APIs

Service Discovery

  • registerInstance(serviceName, instance, [groupName]) Register an instance to service.
    • serviceName {String} Service name
    • instance {Instance}
      • ip {String} IP of instance
      • port {Number} Port of instance
      • [weight] {Number} weight of the instance, default is 1.0
      • [ephemeral] {Boolean} active until the client is alive, default is true
      • [clusterName] {String} Virtual cluster name
    • [groupName] {String} group name, default is DEFAULT_GROUP
  • deregisterInstance(serviceName, ip, port, [cluster]) Delete instance from service.
    • serviceName {String} Service name
    • instance {Instance}
      • ip {String} IP of instance
      • port {Number} Port of instance
      • [weight] {Number} weight of the instance, default is 1.0
      • [ephemeral] {Boolean} active until the client is alive, default is true
      • [clusterName] {String} Virtual cluster name
    • [groupName] {String} group name, default is DEFAULT_GROUP
  • getAllInstances(serviceName, [groupName], [clusters], [subscribe]) Query instance list of service.
    • serviceName {String} Service name
    • [groupName] {String} group name, default is DEFAULT_GROUP
    • [clusters] {String} Cluster names
    • [subscribe] {Boolean} whether subscribe the service, default is true
  • getServerStatus() Get the status of nacos server, 'UP' or 'DOWN'.
  • subscribe(info, listener) Subscribe the instances of the service
    • info {Object}|{String} service info, if type is string, it's the serviceName
    • listener {Function} the listener function
  • unSubscribe(info, [listener]) Unsubscribe the instances of the service
    • info {Object}|{String} service info, if type is string, it's the serviceName
    • listener {Function} the listener function, if not provide, will unSubscribe all listeners under this service

Config Service

  • async function getConfig(dataId, group)
    • {String} dataId - data id
    • {String} group - group name
  • async function publishSingle(dataId, group, content)
    • {String} dataId - data id
    • {String} group - group name
    • {String} content - content you want to publish
  • async function remove(dataId, group)
    • {String} dataId - data id
    • {String} group - group name
  • function subscribe(info, listener)
    • {Object} info
      • {String} dataId - data id
      • {String} group - group name
    • {Function} listener - callback handler
  • function unSubscribe(info, [listener])
    • {Object} info
      • {String} dataId - data id
      • {String} group - group
    • {Function} listener - callback handler(optional,remove all listener when it is null)

Questions & Suggestions

Please let us know how can we help. Do check out issues for bug reports or suggestions first.

PR is welcome.

nacos-sdk-nodejs ding group : 44654232 image

License

Apache License V2