xy-config 配置

安装

1.NPM 方式（推荐）

pnpm add xy-config

2.CDN 方式：

<script src="https://cdn.jsdelivr.net/npm/xy-config/dist/index.global.js"></script>

使用方法

1. 导入函数

import { createConfig } from 'xy-config'

2. 创建 Config 实例

import { createConfig } from 'xy-config'

const config = createConfig({
  app: {
    name: 'my-app',
    version: '1.0.0'
  }
})

3. 基本使用

get 方法

获取指定的数据：

// 获取所有数据
console.log(config.get('app.name')) // my-app

isEqual 方法

判断两个值是否相等：

// 使用 value 获取数据
console.log(config.isEqual('app.name', 'my-app')) // true

includes 方法

判断后面的数据是否包含前面的数据：

console.log(config.includes('app.name', ['my-app', 'app-name'])) // true

API 文档

创建函数

createConfig

declare function createConfig<T extends Record<string, any>>(config: T): Config<T>

示例：

const config = createConfig({
  app: {
    name: 'my-app',
  }
})

方法

get

get(
  key: string
)

isEqual

getLabel(
  key: string,
  value: any
): boolean

includes

includes(
  key: string,
  value: any
): boolean