Interface IResultCatalog

Resolves result code definitions and localized messages.

interface IResultCatalog {
    getResult(code: ResultCode, lang?: string): SingleResult | undefined;
    getDefinition(code: ResultCode): ResultCodeDefinition | undefined;
    listCodes(): ResultCode[];
}

Implemented by

ResultCatalog

Index

Methods

getResult getDefinition listCodes

Methods

getResult

getResult(code: ResultCode, lang?: string): SingleResult | undefined
Returns a resolved result object for a code in the requested language.
Parameters
- code: ResultCode
- Optionallang: string
Returns SingleResult | undefined
- Defined in types.ts:40

getDefinition

getDefinition(code: ResultCode): ResultCodeDefinition | undefined
Returns the raw definition stored for a code.
Parameters
- code: ResultCode
Returns ResultCodeDefinition | undefined
- Defined in types.ts:45

listCodes

listCodes(): ResultCode[]
Lists all registered codes.

Returns ResultCode[]
- Defined in types.ts:50