Sanity Library Reference Docs
    Preparing search index...

    Interface SanityDocumentLike

    Similar to SanityDocument but only requires the _id and _type

    SanityDocument

    interface SanityDocumentLike {
        _createdAt?: string;
        _id: string;
        _rev?: string;
        _system?: Partial<DocumentSystem>;
        _type: string;
        _updatedAt?: string;
        [key: string]: unknown;
    }

    Hierarchy (View Summary)

    Indexable

    • [key: string]: unknown
    Index

    Properties

    _createdAt? _id _rev? _system? _type _updatedAt?

    Properties

    Optional_createdAt

    _createdAt?: string

    _id

    _id: string

    Optional_rev

    _rev?: string

    Optional_system

    _system?: Partial<DocumentSystem>

    System-managed attributes. Which fields are present depends on the document (e.g. variant/scopeId only exist on version documents, and documents predating the _system migration may carry only some of them), hence the partial shape.

    _type

    _type: string

    Optional_updatedAt

    _updatedAt?: string

    Settings

    Member Visibility

    On This Page

    Properties