Interface Instance
interface Instance {
get data(): InstanceData;
get whfsType(): string;
as<Type extends keyof WHFSTypes>(
type: Type,
): Instance & TypedInstance<Type>;
assertType<Type extends keyof WHFSTypes>(
type: Type,
): asserts this is TypedInstance<Type>;
export(options?: ExportOptions): Promise<InstanceExport>;
is<Type extends keyof WHFSTypes>(
type: string | Type,
): this is TypedInstance<Type>;
}
get data(): InstanceData;
get whfsType(): string;
as<Type extends keyof WHFSTypes>(
type: Type,
): Instance & TypedInstance<Type>;
assertType<Type extends keyof WHFSTypes>(
type: Type,
): asserts this is TypedInstance<Type>;
export(options?: ExportOptions): Promise<InstanceExport>;
is<Type extends keyof WHFSTypes>(
type: string | Type,
): this is TypedInstance<Type>;
}
Accessors
data
Returns InstanceData
whfs Type
- get whfsType(): string
Returns string
Methods
as
Type Parameters
- Type extends keyof WHFSTypes
Parameters
- type: Type
Returns Instance & TypedInstance<Type>
assert Type
Type Parameters
- Type extends keyof WHFSTypes
Parameters
- type: Type
Returns asserts this is TypedInstance<Type>
export
Parameters
Optionaloptions: ExportOptions
Returns Promise<InstanceExport>
is
Type Parameters
- Type extends keyof WHFSTypes
Parameters
- type: string | Type
Returns this is TypedInstance<Type>