Instance | WebHare Platform SDK
WebHare Platform SDK
    Preparing search index...

    Interface Instance

    interface Instance {
        get "[dbLoc]"(): null | WebHareDBLocation;
        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<ExportedInstance>;
        is<Type extends keyof WHFSTypes>(
            type: string | Type,
        ): this is TypedInstance<Type>;
    }
    Index

    Accessors

    • get "[dbLoc]"(): null | WebHareDBLocation

      Returns null | WebHareDBLocation

    • get whfsType(): string

      Returns string

    Methods

    • Type Parameters

      • Type extends keyof WHFSTypes

      Parameters

      Returns asserts this is TypedInstance<Type>

    • Type Parameters

      • Type extends keyof WHFSTypes

      Parameters

      Returns this is TypedInstance<Type>