ConfigReader

class

ConfigReader

source
export class ConfigReader
export class ConfigReader
constructor(filepath: string)
constructor(filepath: string)
ParamTypeRequired
filepath
filepath
string
string
Yes
client()
client()
config()
config()
get source

.build()

build()
build()
sharding()
sharding()
public async source

.read(...)

read(options?: JitiResolveOptions): Promise<ConfigReader>
read(options?: JitiResolveOptions): Promise<ConfigReader>
ParamTypeRequired
options
options
JitiResolveOptions
JitiResolveOptions
No

Returns:

Promise<ConfigReader>
Promise<ConfigReader>

public async source

.create(...)

create(options: Omit<ConfigReader.CreateOptions, "path">): Promise<ConfigReader>
create(options: Omit<ConfigReader.CreateOptions, "path">): Promise<ConfigReader>
ParamTypeRequired
options
options
Omit<ConfigReader.CreateOptions, "path">
Omit<ConfigReader.CreateOptions, "path">
Yes

Returns:

Promise<ConfigReader>
Promise<ConfigReader>

public static async source

.exists(...)

exists(file: string): Promise<boolean>
exists(file: string): Promise<boolean>
ParamTypeRequired
file
file
string
string
Yes

Returns:

Promise<boolean>
Promise<boolean>

public static async source

.find(...)

find(options?: ConfigReader.FindOptions): Promise<string|null>
find(options?: ConfigReader.FindOptions): Promise<string|null>
ParamTypeRequired
options
options
ConfigReader.FindOptions
ConfigReader.FindOptions
No

Returns:

Promise<string|null>
Promise<string|null>

Client|null
Client|null
Config|null
Config|null
private source

._build

BuildConfig|null
BuildConfig|null
ShardingManagerOptions|null
ShardingManagerOptions|null