# ct-adc-const > A Vue.js project Latest version **1.0.3** (published 2019-09-17) · 0 weekly downloads ## Install ```sh npm install ct-adc-const pnpm add ct-adc-const yarn add ct-adc-const bun add ct-adc-const ``` ## 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 | 1.0.3 | | Published | 2019-09-17 | | First published | 2018-04-03 | | Weekly downloads | 0 | | TypeScript types | none | | Module format | CommonJS | | Node | >= 4.0.0 | | Dependencies | 2 | | Unpacked size | 75.6 KB | | Known vulnerabilities | 0 (+24 in 1 direct dependencies) | | Install scripts | no | | Author | skysunshine99 | | Maintainers | rubyisapm | ## Links - npm: https://www.npmjs.com/package/ct-adc-const - npm.io page: https://npm.io/package/ct-adc-const ## Dependencies (2) - [axios](https://npm.io/package/axios.md) ^0.18.0 - [ct-utility](https://npm.io/package/ct-utility.md) ^1.0.3 ## Recent versions - 1.0.3 (latest) — 2019-09-17 - 1.0.2 — 2019-09-17 - 1.0.1 — 2019-09-17 - 1.0.0 — 2019-04-19 - 1.0.0-alpha.3 — 2018-05-08 - 1.0.0-alpha.2 — 2018-04-04 - 1.0.0-alpha.1 — 2018-04-03 ## README ## ct-adc-const 用于维护项目中前后端约定好的一些常量 ## 组件示例图 无 ## 在线demo 无 ## 功能点 1. 集中管理常量 2. 满足不同的获取常量的需求，如是否带有默认值，是否需要过滤出常量的子集合 3. 支持异步获取的常量，或静态的常量配置 ## 使用 从npm安装ct-adc-const ``` npm install ct-adc-const --save ``` 在代码中使用 ``` import Const from 'const'; const con = new Const(); const status = [{ key: '', val: '不限' }, { key: 1, val: '已启用' }, { key: 2, val: '已禁用' }]; const os = [{ key: '', val: '不限' }, { key: 1, val: '安卓' }, { key: 2, val: 'IOS' }]; const tagType = [{ key: '', val: '请选择' }, { key: true, val: '标签' }, { key: false, val: '非标签' }]; // 添加静态常量 con.add({status: status, os: os}); con.add({tagType}); // 注册异步常量 con.register('type', { axios: { url: '/api/type', transformResponse: [data=>{ data = JSON.parse(data); if (data.Code === 0){ return { status: true, data: data.Data }; } return { status: false, data: [] }; }], params: { owner: 'tcy' } }, resolve: { key: 'Id', val: 'Val' } }); export default con; ``` 值得说明的是，当前的插件其实就是提供一个Const类，开发者可以根据项目需求定义一个Const实例，在需要的时候调用该实例的相关方法。 ## 方法 ### add 添加静态数据 #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- dataList | 需要添加的数据列表 | Object | {} | 如下描述 | 需要添加的数据列表 dataList必须满足以下条件： 1. 每项的值为一个数组，即常量数据的值列表。 2. 值列表中的每项必须包含两个属性，分别为key和val。 3. dataList中每项的key为常量数据的key，后续需据此获取数据。如下例中的tagType 4. 值列表的第一项必须是默认项，且默认值的val必须为'不限' 举例说明： ``` { tagType: [{ key: '', val: '不限' }, { key: true, val: '标签' }, { key: false, val: '非标签' }] } ``` 返回值 undefined #### 使用示例 ``` const status = [{ key: '', val: '不限' }, { key: 1, val: '已启用' }, { key: 2, val: '已禁用' }]; con.add({status}); ``` ### register 注册异步数据 #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- col | 指定数据的key | String | 无 | 任何String | 后续会据此获取数据 options | 异步数据配置 | Object | [异步数据配置](#options) | [异步数据配置](#options) | [异步数据配置](#options) #### 返回值 undefined #### 使用示例 ``` con.register('type', { axios: { url: '/api/type', params: { owner: 'tcy' } }, resolve: { key: 'Id', val: 'Val' } }); ``` ### Const实例[常量] 例如Const实例con, 在con上register一个异步数据type，Const内部会写入一个异步数据type，con.type为一个方法，即为该方法 #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- options | 异步数据配置 | Object | [异步数据配置](#options) | [异步数据配置](#options) | [异步数据配置](#options) 开发者在获取异步数据时，可能有改写默认配置的需求，所以此处会提供options参数。 当然，如果开发者只是需要按照register时的配置进行数据请求，那么该处的参数可以不传。 #### 返回值 一个promise对象 如果该异步操作的options的resolve为false, 那么promise只会发起数据请求后直接返回，否则，在返回之前会按照options.resolve规则进行数据处理 ### ensure 确保异步数据获取成功的任务。当一些异步数据确认获取后再进行下一步操作时可以使用该方法 #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- list | 需要请求的数据 | {Object|Array} | 无 | 见下 | list支持两种指定方式： 1. 每一项为一个数据key，如['tagType', 'status']，那么将获取tagType和status两个常量 2. 每一项为一个对象，其中对象的col属性指定了数据key, 而options则可以覆盖注册异步数据时的某些配置，来获取数据。如： ``` { col: 'type', options: { axios: { params: { owner: 'tcy' } } } } ``` #### 返回值 一个Promise实例，即使用Promise.all(数据任务队列)生成的Promise实例。 ### getData 获取一个常量数据 #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- conf | 获取数据时的选项 | Object/String | 无 | 见下方 | 当类型为string时该值会被作为conf.col解析，类型为Object时见下方 - col | 要获取的数据的key | String | 无 | 已添加或注册到Const实例的常量的key | 以此来获取对应的常量 - hasDef | 结果中是否需要包含默认值 | Boolean | true | true/false | - def | 结果中的默认值对应的val是什么 | 基本类型 | '不限' | 任何基本类型的值 | hasDef为true时生效 - filterByKey | 结果中需要包含的项 | Array | undefined | 每项为任何基本类型的值 | key等于其中任一项的常量项会被返回 - filterByVal | 结果中需要包含的项 | Array | undefined | 每项为任何基本类型的值 | val等于其中任一项的常量项会被返回 - keyStandby | 结果中把key字段转换为指定的字段名 | 合法的对象属性名类型均可， 推荐String | undefined | 任何可作为对象属性名的值 | 返回的结果中会把key字段名替换为该值 - valStandby | 结果中把val字段转换为指定的字段名 | 合法的对象属性名类型均可， 推荐String | undefined | 任何可作为对象属性名的值 | 返回的结果中会把val字段名替换为该值 ##### conf * conf{String} 已添加或注册到Const实例的常量的key，以此来获取对应的常量 * conf{Object} ``` { col: 'os', hasDef: true, def: '请选择', filterByKey: [1], filterByVal: ['android'] } ``` #### 返回值 Array 即要获取的常量数据 ### getVal 根据key获取val #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- col | 要获取的数据的key | String | 无 | 已添加或注册到Const实例的常量的key | 以此来获取对应的常量 key | 指定的key |基本类型 | 无 | 基本类型 | col对应的常量中key等于此值的项的val会被返回 def | 默认值的val | 基本类型 | '不限' | 基本类型 | 当对应到的项为默认项时，需要将默认项的val转换为该值 #### 返回值 基本类型 或 undefined 当匹配到内容时，返回对应的val；匹配不到时返回undefined; ### getKey 根据val获取key #### 参数列表 参数 | 说明 | 类型 | 默认值 | 可选值 | 描述 | --- | --- | --- | --- | ---- | ---- col | 要获取的数据的key | String | 无 | 已添加或注册到Const实例的常量的key | 以此来获取对应的常量 val | 指定的val |基本类型 | 无 | 基本类型 | col对应的常量中val等于此值的项的key会被返回 #### 返回值 基本类型 或 undefined 当匹配到内容时，返回对应的key；匹配不到时返回undefined; ## 其他 ### options options的结构如下： #### options.axios {Object} [axios官方文档](https://github.com/axios/axios) 需要注意的是，该插件通过axios.transformResponse将响应数据转换为形如{status: true/false, data: []}的对象。transformResponse的默认值[见下方](#options的默认配置)。 当接口响应数据不是以下这种形式时，需要开发者自定定义transformResponse。 ``` { Code: 0, //为0时表示成功 Data: [{...}, {...}] } ``` #### options.cache {Boolean} 此项指定异步数据在请求前，如果缓存有值是否读取缓存 #### options.default {Object} 因该插件要求常量一定有默认值，所以当开发者明确知道响应数据中没有默认值时，需要将default.append设置为true,并通过default.key指定默认值的key ``` default: { //是否加入默认值 append: true, //该默认值中key字段的值 key: '' } ``` #### options.resolve {Boolean | Object} options.resolve 为 false时，表示不进行数据处理 options.resolve 为 object时，指定如何处理异步数据，其中resolve.key和resolve.val指定了要把数据中的哪两个key用来生成最终的key/val. ``` resolve: { key: 'Id', // 将Id转换为key val: 'Val' // 将Val转换为val } ``` ##### options的默认配置 ``` { //axios配置项，参考axios官方文档 axios: { url: '', method: 'get', transformResponse: [(data) => { data = JSON.parse(data); if (data.Code === 0) { return { status: true, data: data.Data }; } return { status: false, data: [] }; }] }, //是否读取缓存数据 cache: true, //是否需要自动加入一个默认值 default: { //是否加入默认值 append: true, //该默认值中key字段的值 key: '' }, resolve: false } ``` ## 注意事项 1. 每个常量中的每一项必须含有key和val两个属性 2. 每个常量数据必须有一个默认值，且该默认值的val必须为'不限' ## 更新日志 [更新日志]({CHANGELOG.md的线上地址}) ## 外部资源依赖列表 - jdPicker.js V2.0.0+ - webUploader V1.5.0+ --- _Source: https://npm.io/package/ct-adc-const · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._