Sanity Library Reference Docs
    Preparing search index...

    Interface ReleaseHandleBeta

    Identifies a release within a Sanity dataset and project. releaseId is the name parameter on the release document (e.g. {name: 'r41035a4'}). The underlying release document ID is _.releases.<releaseId>. It's also the id parameter sent to the Actions API. (This type doesn't need to have ProjectId / Dataset generics since it's always the same shape)

    interface ReleaseHandle {
        dataset?: string;
        perspective?: ReleasePerspective | ClientPerspective;
        projectId?: string;
        releaseId: string;
        resource?: DocumentResource;
    }

    Hierarchy (View Summary)

    Index

    Properties

    dataset? perspective? projectId? releaseId resource?

    Properties

    dataset?: string
    perspective?: ReleasePerspective | ClientPerspective
    projectId?: string
    releaseId: string
    resource?: DocumentResource

    Explicit resource to use. On an individual operation this overrides any default; on a SanityConfig it becomes the instance's default resource. Unlike projectId/dataset, this can also be a media library or canvas resource.

    Settings

    Member Visibility

    On This Page

    Properties