# jm-ms

> microService lib, light and fast

Latest version **2.2.0** (published 2020-04-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install jm-ms
pnpm add jm-ms
yarn add jm-ms
bun add jm-ms
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.2.0 |
| Published | 2020-04-15 |
| First published | 2016-07-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 31.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Jeff YU |
| Maintainers | jeffyu |
| Keywords | javascript, jm-ms |

## Links

- npm: https://www.npmjs.com/package/jm-ms
- Repository: https://github.com/jm-root/ms
- Issues: https://github.com/jm-root/ms/issues
- npm.io page: https://npm.io/package/jm-ms

## Dependencies (5)

- [jm-ms-core](https://npm.io/package/jm-ms-core.md) ^2.1.0
- [jm-ms-ws-client](https://npm.io/package/jm-ms-ws-client.md) ^2.2.0
- [jm-ms-ws-server](https://npm.io/package/jm-ms-ws-server.md) ^2.1.0
- [jm-ms-http-client](https://npm.io/package/jm-ms-http-client.md) ^2.2.0
- [jm-ms-http-server](https://npm.io/package/jm-ms-http-server.md) ^2.1.0

## Recent versions

- 2.2.0 (latest) — 2020-04-15
- 2.2.0-beta.1 (beta) — 2020-03-03
- 3.0.0-beta — 2020-02-27
- 2.2.0-beta — 2020-02-27
- 2.1.1 — 2018-09-09
- 2.1.0 — 2018-09-09
- 2.0.3 — 2018-09-07
- 2.0.2 — 2018-08-22
- 2.0.1 — 2018-07-19
- 2.0.0 — 2018-07-19
- 1.1.1 — 2018-06-30
- 1.0.2 — 2017-12-18
- 1.0.1 — 2017-10-07
- 1.0.0 — 2017-07-12
- 0.0.19 — 2017-04-11
- … 17 more at https://npm.io/package/jm-ms/versions

## README

---
theme : "white"
---

# jm-ms

micro service lib, light and fast

<small>作者：[鱼哥](https://github.com/jammacn)</small>

---

## features

- 路由式编程模式 基于 jm-route

- 支持多协议 http、ws

- 支持服务器 server

- 支持客户端 client

- 支持代理转发 proxy

---

## install

```
npm i jm-ms
```

---

## use:

```
const MS = require('jm-ms')
const ms = new MS()
```

---

## 构造函数 MS

参数 opts

- logging [false] 是否打印日志

- benchmark [false] 是否计算耗时

- disable_client [false] 禁用client模块

- disable_server [false] 禁用server模块

---

## 路由器 router

负责管理路由 route

--

### 工序函数

- 有且只有一个参数 opts (json 对象)

--

### 异常抛出

抛出异常需要按以下格式

```
const e = new Error('这里填错误信息')
e.code = 1000 // 错误编码，可选
e.status = 500 // 对应的标准 HTTP 错误状态码，可选
e.data = {
    err: 1000, // 错误编码
    msg: '这里填错误信息',
    status: 500, // 对应的标准 HTTP 错误状态码，可选
    data: {}, // 附加数据，可选
    ... // 其他自定义错误内容
}
throw e
```

--

### 异常抛出 jm-err

采用 jm-err 简化异常生成

```
const error = require('jm-err')
// jm-err 的 Err 中定义了常见错误
const doc = error.Err.FA_NOAUTH
throw error.err(doc)

// 也可以自定义 doc 对象
const doc1 = {
    status: 401,
    err: 401,
    msg: 'Unauthorized'
}
throw error.err(doc1)
```

--

### 创建 router

```
const router = ms.router()
```

--

### 添加路由 router.add

- add({uri:uri, type:type, fn:fn})
- add({uri:uri, type:type, fn:[fn1, fn2, ..., fnn]})

--

### 简便写法

- add(uri, type, fn)
- add(uri, type, fn1, fn2, ..., fnn)
- add(uri, type, [fn1, fn2, ..,fnn])
- add(uri, fn)
- add(uri, fn1, fn2, ..., fnn)
- add(uri, [fn1, fn2, ..,fnn])

```
router.add('/', 'get', fn1, fn2)
```

--

### 添加路由 router.use

- use({uri:uri, fn:fn})
- use({uri:uri, fn:[fn1, fn2, ..., fnn]})
- use({uri:uri, fn:router})
- use({uri:uri, fn:obj}) obj必须实现了request或者execute之一

--

### 简便写法

- use(uri, fn)
- use(uri, fn1, fn2, ..., fnn)
- use(uri, [fn1, fn2, ..,fnn])
- use(uri, router)
- use(uri, obj)
- use(router)
- use(obj) 
- use(fn1, fn2, ..., fnn)
- use([fn1, fn2, ..,fnn])

```
router.use(fn1, fn2)
```

--

### 清除路由 router.clear

```
router.clear()
```

--

### 请求 router.request

```
router.request({
    uri:'/', // 请求 uri
    type:'get', // 请求类型
    headers:{}, // 请求头
    data:{}, // 请求数据
    params:{}, // 请求参数 
    timeout: 0, // 请求超时时间，单位ms
    ...
})
```

--

### 简便写法

- request(uri, type, data, opts)
- request(uri, type, data)
- request(uri, type)
- request(uri)

```
let doc = await router.request('/', 'get', {id: 1})
```

--

### 简便写法

- post(uri, data, opts)
- put(uri, data, opts)
- get(uri, data)
- delete(uri)

```
let doc = await router.get('/')
```

--

### 完整例子

```
const MS = require('jm-ms')
const ms = new MS()
let router = ms.router()
router.add('/', 'get', opts => { return opts})
let doc = await router.get('/')
```

---

## 服务器 server

```
const MS = require('jm-ms')
const ms = new MS()
let router = ms.router()
router.add('/', 'get', opts => { return opts})

// http 服务器
await ms.server(router, {type: 'http', port: 3000})

// websocket 服务器
await ms.server(router, {type: 'ws', port: 3001})
```

---

## 客户端 client

```
const MS = require('jm-ms')
const ms = new MS()

// http
let client = await ms.client('http://api.test.jamma.cn')
let doc = await client.get('/')
doc = await client.post('/users', {name: '鱼哥'})
```

```
// ws
let client = await ms.client('ws://api.test.jamma.cn')
let doc = await client.get('/')
doc = await client.post('/users', {name: '鱼哥'})
```

---
_Source: https://npm.io/package/jm-ms · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._