Type Alias ConfigStub

ConfigStub: {
    contents?: ConfigContents;
    readFn?: (() => Promise<ConfigContents>);
    retrieveContents?: (() => Promise<JsonMap>);
    writeFn?: ((contents?: AnyJson) => Promise<void>);
}

Different hooks into ConfigFile used for testing instead of doing file IO.

Type declaration

  • Optionalcontents?: ConfigContents

    The contents that are used with @{link ConfigFile.readSync} and @{link ConfigFile.read}. If retrieveContents is set, it will use that instead of @{link ConfigFile.read} but NOT @{link ConfigFile.readSync}. This will also contain the new config when @{link ConfigFile.write} or @{link ConfigFile.writeSync} is called. This will persist through config instances, such as Alias.update and Alias.fetch.

  • OptionalreadFn?: (() => Promise<ConfigContents>)

    readFn A function that controls all aspect of ConfigFile.read. For example, it won't set the contents unless explicitly done. Only use this if you know what you are doing. Use retrieveContents instead.

  • OptionalretrieveContents?: (() => Promise<JsonMap>)

    A function to conditionally read based on the config instance. The this value will be the config instance.

      • (): Promise<JsonMap>

      • Returns Promise<JsonMap>

  • OptionalwriteFn?: ((contents?: AnyJson) => Promise<void>)

    A function that controls all aspects of ConfigFile.write. For example, it won't read the contents unless explicitly done. Only use this if you know what you are doing. Use updateContents instead.

      • (contents?): Promise<void>

      • Parameters

        • Optionalcontents: AnyJson

        Returns Promise<void>

Settings

Member Visibility