@dxos/app-toolkit - v0.16.0
    Preparing search index...

    Variable companionConst

    companion: {
        <TToken extends Role<any>>(
            token: TToken,
        ): Filter<{ companionTo: Obj.Any }>;
        <TToken extends Role<any>, S extends AnyEntity>(
            token: TToken,
            schema: S,
        ): Filter<{ companionTo: Type.InstanceType<S> }>;
        <TToken extends Role<any>, T extends string>(
            token: TToken,
            value: T,
        ): Filter<{ companionTo: T }>;
        <TToken extends Role<any>, T>(
            token: TToken,
            guard: (value: unknown) => value is T,
        ): Filter<{ companionTo: T }>;
    } = ...

    Filter: requires data.companionTo to match the given schema, literal string, type predicate, or (with no second argument) any ECHO object. Pair with allOf and object to express "article displaying X whose companion is Y".

    Type declaration

      • <TToken extends Role<any>>(token: TToken): Filter<{ companionTo: Obj.Any }>

      • Type Parameters

        • TToken extends Role<any>

        Parameters

        Returns Filter<{ companionTo: Obj.Any }>

      • <TToken extends Role<any>, S extends AnyEntity>(
            token: TToken,
            schema: S,
        ): Filter<{ companionTo: Type.InstanceType<S> }>

      • Type Parameters

        • TToken extends Role<any>
        • S extends AnyEntity

        Parameters

        Returns Filter<{ companionTo: Type.InstanceType<S> }>

      • <TToken extends Role<any>, T extends string>(
            token: TToken,
            value: T,
        ): Filter<{ companionTo: T }>

      • Type Parameters

        • TToken extends Role<any>
        • T extends string

        Parameters

        Returns Filter<{ companionTo: T }>

      • <TToken extends Role<any>, T>(
            token: TToken,
            guard: (value: unknown) => value is T,
        ): Filter<{ companionTo: T }>

      • Type Parameters

        • TToken extends Role<any>
        • T

        Parameters

        • token: TToken
        • guard: (value: unknown) => value is T

        Returns Filter<{ companionTo: T }>

    Settings

    Member Visibility