# @nestcloud2/service > NestCloud is a Node.js micro-service solution, writing by Typescript language and Nest.js. Latest version **0.8.5** (published 2022-09-12) · MIT license · 0 weekly downloads ## Install ```sh npm install @nestcloud2/service pnpm add @nestcloud2/service yarn add @nestcloud2/service bun add @nestcloud2/service ``` ## Health **Score 20/100 (F)** — status: abandoned. Positive: has types; no vulnerabilities. Warnings: low downloads; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.8.5 | | Published | 2022-09-12 | | First published | 2022-05-16 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 3 | | Unpacked size | 44.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 419 | | Author | Miaowing | | Maintainers | ahdng | ## Links - npm: https://www.npmjs.com/package/@nestcloud2/service - Repository: https://github.com/nest-cloud/nestcloud - Homepage: https://github.com/nest-cloud/nestcloud#readme - Issues: https://github.com/nest-cloud/nestcloud/issues - npm.io page: https://npm.io/package/@nestcloud2/service ## Dependencies (3) - [lodash](https://npm.io/package/lodash.md) ^4.17.11 - [yamljs](https://npm.io/package/yamljs.md) ^0.3.0 - [blueimp-md5](https://npm.io/package/blueimp-md5.md) ^2.10.0 ## Recent versions - 0.8.5 (latest) — 2022-09-12 - 0.9.1 (next) — 2022-10-04 - 0.9.1-rc.0 (test) — 2022-09-14 - 0.9.0 (rc) — 2022-09-14 - 0.8.4 — 2022-07-04 - 0.8.3 — 2022-05-31 - 0.8.0 — 2022-05-16 ## README [travis-image]: https://api.travis-ci.org/nest-cloud/nestcloud.svg?branch=master [travis-url]: https://travis-ci.org/nest-cloud/nestcloud [linux-image]: https://img.shields.io/travis/nest-cloud/nestcloud/master.svg?label=linux [linux-url]: https://travis-ci.org/nest-cloud/nestcloud # NestCloud - Service

NPM Version Package License NPM Downloads Travis Linux Coverage

## Description A NestCloud component for service registration and service discovery. ## Installation ```bash $ npm install @nestcloud2/service --save ``` ## Quick Start ### Import Module This module dependency other modules, you need import `@nestcloud2/consul` or `@nestcloud2/etcd` module before import it. ```typescript import { Module } from '@nestjs/common'; import { resolve } from 'path'; import { ConsulModule } from '@nestcloud2/consul'; import { ServiceModule } from '@nestcloud2/service'; import { EtcdModule } from '@nestcloud2/etcd'; import { BootModule } from '@nestcloud2/boot'; import { BOOT, CONSUL, ETCD } from '@nestcloud2/common'; @Module({ imports: [ BootModule.forRoot({ filePath: resolve(__dirname, '../config.yaml'), }), // consul backend ConsulModule.forRootAsync({ inject: [BOOT] }), ServiceModule.forRootAsync({ inject: [BOOT, CONSUL] }), // etcd backend EtcdModule.forRootAsync({ inject: [BOOT] }), ServiceModule.forRootAsync({ inject: [BOOT, ETCD] }), ], }) export class AppModule {} ``` ### config.yaml ```yaml service: discoveryHost: localhost id: your-service-id name: your-service-name port: 3000 tags: ['v1.0.1'] healthCheck: timeout: 1s interval: 10s route: /health maxRetry: 5 retryInterval: 5000 ``` ## Usage ```typescript import { Injectable } from '@nestjs/common'; import { InjectService, Service } from '@nestcloud2/service'; @Injectable() export class TestService { constructor(@InjectService() private readonly service: Service) {} getServiceServers() { const servers = this.service.getServiceServers('user-service', { passing: true }); this.service.watch('user-service', nodes => { console.log(nodes); }); console.log(nodes); } } ``` ## Checks ### Script + Interval ```yaml service: healthCheck: timeout: 1s interval: 10s script: /root/script/check.sh ``` ### Http + Interval ```yaml service: healthCheck: timeout: 1s interval: 10s protocol: http route: /health ``` ### Tcp + Interval ```yaml service: healthCheck: timeout: 1s interval: 10s tcp: localhost:3000 ``` ### Time To Live ```yaml service: healthCheck: ttl: 60s ``` ### Docker + Interval ```yaml service: healthCheck: dockerContainerId: 2ddd99fd268c ``` ## API ### class ServiceModule #### static register\(options: RegisterOptions\): DynamicModule Import nest consul service module. | field | type | description | | :------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------- | | options.dependencies | string[] | if you are using @nestcloud2/boot module, please set [BOOT] | | options.id | string | the service id | | options.name | string | the service name | | options.port | number | the service port, if not set, it will use random port | | options.tags | number | the service tags | | options.includes | string[] | sync services from consul, if not set, it will sync all services | | options.discoveryHost | string | the discovery ip | | options.healthCheck.timeout | number | the health check timeout, default 1s | | options.healthCheck.interval | number | the health check interval，default 10s | | options.healthCheck.deregisterCriticalServiceAfter | string | timeout after which to automatically deregister service if check remains in critical state | | options.healthCheck.protocol | string | https or http, default is http. | | options.healthCheck.tcp | string | host:port to test, passes if connection is established, fails otherwise. | | options.healthCheck.script | string | path to check script, requires interval. | | options.healthCheck.dockerContainerId | string | Docker container ID to run script. | | options.healthCheck.shell | string | shell in which to run script (currently only supported with Docker). | | options.healthCheck.ttl | string | time to live before check must be updated, instead of http/tcp/script and interval (ex: 60s). | | options.healthCheck.notes | string | human readable description of check. | | options.healthCheck.status | string | initial service status. | | options.healthCheck.route | string | the health check url, default is /health. | | options.maxRetry | number | the max retry count when register service fail | | options.retryInterval | number | the retry interval when register service fail | ### class Service #### getServices\(\): ServiceServer[] Get all services with nodes. #### getServiceNames\(\): string[] Get all service names #### watch(service: string, callback: (nodes: IServiceServer[]) => void): void watch service nodes change #### watchServiceList(callback: (services: string[]) => void): void watch service name list change ## Stay in touch - Author - [NestCloud](https://github.com/nest-cloud) ## License NestCloud is [MIT licensed](LICENSE). --- _Source: https://npm.io/package/@nestcloud2/service · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._