Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigData

内置的全局配置内容查找服务。

通过调用 Platform.load_config 可以加载配置文件,并将配置内容保存到 "ConfigData" 中。

NPM 包 tora-check 提供了一种检查位置文件是否符合类型 的方法。

// 你可以通过如下方式修改 <ToraConfigSchema>:

import { ConfigData } from './config-data'

declare global {
    interface ToraConfigSchema {
        sample: {
            sample_property1: 255
            sample_property2: 'sample'
        }
    }
}

// 修改之后的 <ToraConfigSchema> 大概长成下面这样:

interface ToraConfigSchema {
    sample: {
        sample_property1: 255
        sample_property2: 'sample'
    }
    tora?: {
        port?: number
    }
}

// 此时使用如下方式查找配置内容,typescript 会检查配置文件路径是否合法,IDE(如:Idea)也会给出相应的配置路径提示:

@ToraComponent()
export class SampleToraComponent {

    constructor(
        private _config: ConfigData
    ) {
    }

    get_sample_property1(): number {
        return this._config.get('sample.sample_property1')
    }

    get_sample_property2(): string {
        return this._config.get('sample.sample_property2')
    }
}

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new ConfigData(data: ToraConfigSchema): ConfigData

Properties

data

data: ToraConfigSchema

Methods

get

  • get<K>(): ToraConfigSchema
  • get<K>(path: K): PathValue<ToraConfigSchema, K>

Generated using TypeDoc