Optional ctx: InvocationContextPrivate ctxRetrieves the type specified by the root and path. example:
const itemTypeWithProperties = await new Types(ctx).getByRootAndPath({ root: 'item', path: 'item', relations: ['typeProperties'] });
Retrieves the type specified by the options.
The evaluation of the options is done in the following order:
If id is specified, the type is fetched by id.
If root and path are specified, the type is fetched by root and path.
If path is specified, the type is fetched by path.
Private requestStatic clearGenerated using TypeDoc
The types client provides methods for fetching types from the API. The client uses a cache to reduce the number of API calls for repeated requests.
We recommend using getByRootAndPath for most use cases.