Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kenote/config-helper
Configuration helper
https://github.com/kenote/config-helper
assistant config configuration helper kenote typscript
Last synced: 5 days ago
JSON representation
Configuration helper
- Host: GitHub
- URL: https://github.com/kenote/config-helper
- Owner: kenote
- License: mit
- Created: 2019-06-20T15:17:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2020-08-24T08:34:18.000Z (over 4 years ago)
- Last Synced: 2024-12-19T11:47:06.138Z (about 1 month ago)
- Topics: assistant, config, configuration, helper, kenote, typscript
- Language: TypeScript
- Homepage:
- Size: 41 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# config-helper
Configuration helper
[![NPM Version][npm-image]][npm-url]
[![NPM Downloads][downloads-image]][downloads-url]
[![Build Status][travis-image]][travis-url]
[![Gratipay][licensed-image]][licensed-url]
## Installation
```bash
$ npm install kenote-config-helper
# Or
$ yarn add kenote-config-helper
```
## Usages
### Create Channel
`/data/channels/account.yml`
```yaml
---
# 频道 我的帐户 配置 ####################################################################
######################################################################################
# 频道 ID
id : 1
# 频道名称
name : 我的帐户
# 频道标识
label : account
# 频道描述
description : 查看和管理自己的信息、活动、安全选项和隐私偏好设置
# 默认打开页面
default : /account/baseinfo
# 自定义参数
options:
# 用户方案类型
plan_type:
- key : ditch
name : 渠道
- key : sendmail
name : 系统邮件
# 频道导航
navs:
# 导航分栏 -- 帐户管理
- index : 1-1
name : 帐户管理
icon : iconfont icon-passport
children:
- index : /account/baseinfo
name : 基本资料
- index : /account/security
name : 安全设置
- index : /account/plan
name : 方案管理
```
`app.ts`
```typescript
import { KenoteConfig, Channel, getChannelId } from 'kenote-config-helper'
import { loadData } from 'kenote-config-helper/dist/utils.server'
const channels: KenoteConfig.Channel[] = loadData('data/channels', 'array')
const channelId: number = getChannelId('/account/baseinfo')
const channel: KenoteConfig.Channel | undefined = channels.find( _channel => _channel.id === channelId )
if (channel) {
let nav: Navigation = new Channel(channel).find('/account/baseinfo')
/** value for nav
* {
* index : '/account/baseinfo',
* name : '基本资料'
* }
**/
}
```
### Use Error Set
```ts
import { useError, Maps } from 'kenote-config-helper'
const code: Maps = {
ERROR_STATUS_NULL : 0,
ERROR_AUTH_FLAG_ACCESS : 1001
}
const message: Maps = {
ERROR_STATUS_NULL : 'Request Success!',
ERROR_AUTH_FLAG_ACCESS : '没有访问该页面的权限'
}
const start: number = 1000
const { __ErrorCode, __ErrorMessage, ErrorInfo } = useError(code, message, start)
// thrown custom error
throw ErrorInfo(__ErrorCode.ERROR_AUTH_FLAG_ACCESS)
// handing errors
try {
// ...
} catch (error) {
if (CustomError(error)) {
// custom error
}
else {
// system error
}
}
```
## License
this repo is released under the [MIT License][licensed-url].
[npm-image]: https://img.shields.io/npm/v/kenote-config-helper.svg
[npm-url]: https://www.npmjs.com/package/kenote-config-helper
[downloads-image]: https://img.shields.io/npm/dm/kenote-config-helper.svg
[downloads-url]: https://www.npmjs.com/package/kenote-config-helper
[travis-image]: https://travis-ci.com/kenote/config-helper.svg?branch=master
[travis-url]: https://travis-ci.com/kenote/config-helper
[licensed-image]: https://img.shields.io/badge/license-MIT-blue.svg
[licensed-url]: https://github.com/kenote/config-helper/blob/master/LICENSE