Sanity Library Reference Docs
    Preparing search index...

    Interface FavoriteDocument

    A document a user favorited, addressed like Comlink's favorite messages.

    interface FavoriteDocument {
        application:
            | { id: string; type: "studio"; workspaceName: string }
            | { id: string; type: "media-library" | "canvas" };
        createdAt: string;
        document: DashboardDocumentReference & { resource: {} };
        id: string;
        metadata?: { path?: string };
        updatedAt: string;
    }
    Index

    Properties

    application createdAt document id metadata? updatedAt

    Properties

    application:
        | { id: string; type: "studio"; workspaceName: string }
        | { id: string; type: "media-library" | "canvas" }

    Where the document was favorited.

    createdAt: string

    When the document was favorited, as an ISO 8601 timestamp.

    document: DashboardDocumentReference & { resource: {} }

    The favorited document and the resource it lives in.

    id: string

    ID of the stored favorite.

    metadata?: { path?: string }

    Type declaration

    • Optional Readonlypath?: string

      The application path the document was favorited at.

    updatedAt: string

    When the favorite last changed, as an ISO 8601 timestamp.

    Settings

    Member Visibility

    On This Page

    Properties