# Document

This is a `xxx` library with `xxx` features.

## Api template

simple introduction of function

detail introduction of function

parameters and return of function need follow below rules:

- param {string} name1 name1 description
- param {number} [name2] name2 description ([] means optional)
- param {string|number} name3 name3 description (| means multi types)
- param { * } name3 name3 description (* means any type)
- param {boolean} obj.sex definition of compound parameters
- return {string} description for return

For example (must have code example)

```js
// do something
```

special notice for errors and so on.