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

    Variable objectConst

    object: {
        <TToken extends Role<{ subject?: any }>, S extends AnyEntity>(
            token: TToken,
            schema: S,
            predicate?: (data: NonNullable<TokenData<TToken>>) => boolean,
        ): Filter<
            Omit<NonNullable<TokenData<TToken>>, "subject"> & {
                subject: Type.InstanceType<S>;
            },
        >;
        <TToken extends Role<{ subject?: any }>, S extends AnyEntity[]>(
            token: TToken,
            schemas: [...S[]],
            predicate?: (data: NonNullable<TokenData<TToken>>) => boolean,
        ): Filter<
            Omit<NonNullable<TokenData<TToken>>, "subject"> & {
                subject: Type.InstanceType<S[number]>;
            },
        >;
    } = ...

    Filter: matches an ECHO object at the given role token's subject position.

    An optional predicate narrows on the rest of the data — most useful for surfaces that distinguish variants by a flag (e.g. editable, compact) without having to hand-roll a fully typed Surface.Filter.

    Type declaration

      • <TToken extends Role<{ subject?: any }>, S extends AnyEntity>(
            token: TToken,
            schema: S,
            predicate?: (data: NonNullable<TokenData<TToken>>) => boolean,
        ): Filter<
            Omit<NonNullable<TokenData<TToken>>, "subject"> & {
                subject: Type.InstanceType<S>;
            },
        >

      • Type Parameters

        • TToken extends Role<{ subject?: any }>
        • S extends AnyEntity

        Parameters

        • token: TToken
        • schema: S
        • Optionalpredicate: (data: NonNullable<TokenData<TToken>>) => boolean

        Returns Filter<
            Omit<NonNullable<TokenData<TToken>>, "subject"> & {
                subject: Type.InstanceType<S>;
            },
        >

      • <TToken extends Role<{ subject?: any }>, S extends AnyEntity[]>(
            token: TToken,
            schemas: [...S[]],
            predicate?: (data: NonNullable<TokenData<TToken>>) => boolean,
        ): Filter<
            Omit<NonNullable<TokenData<TToken>>, "subject"> & {
                subject: Type.InstanceType<S[number]>;
            },
        >

      • Type Parameters

        • TToken extends Role<{ subject?: any }>
        • S extends AnyEntity[]

        Parameters

        • token: TToken
        • schemas: [...S[]]
        • Optionalpredicate: (data: NonNullable<TokenData<TToken>>) => boolean

        Returns Filter<
            Omit<NonNullable<TokenData<TToken>>, "subject"> & {
                subject: Type.InstanceType<S[number]>;
            },
        >

    Settings

    Member Visibility