Sanity Library Reference Docs
    Preparing search index...

    Module index

    Classes

    ChannelError
    ClientError
    ConnectionFailedError
    CorsOriginError
    DisconnectError
    LiveClient
    MessageError
    MessageParseError
    ObservablePatch
    ObservableSanityClient
    ObservableTransaction
    ObservableUsersClient
    Patch
    SanityClient
    ServerError
    Transaction
    UsersClient

    Interfaces

    AgentActionTarget
    AnimatedTransformOptions
    ArchiveReleaseAction
    ClientConfig
    ConstantAgentActionParam
    ContentSourceMap
    ContentSourceMapDocument
    ContentSourceMapDocumentBase
    ContentSourceMapDocumentValueSource
    ContentSourceMapLiteralSource
    ContentSourceMapRemoteDocument
    ContentSourceMapUnknownSource
    ContentSourceMapValueMapping
    CreateDataAttributeProps
    CreateReleaseAction
    CurrentSanityUser
    DeleteReleaseAction
    DiscardVersionAction
    EditReleaseAction
    ErrorProps
    FilteredResponseQueryOptions
    GenerateTarget
    GenerateTargetInclude
    GroqAgentActionParam
    HttpError
    InitializedClientConfig
    ListenOptions
    LiveEventGoAway
    LiveEventMessage
    LiveEventReconnect
    LiveEventRestart
    LiveEventWelcome
    MediaLibraryPlaybackInfoOptions
    MediaLibraryVideoPlaybackTransformations
    PortableTextBlock
    PortableTextComponentProps
    PortableTextMarkComponentProps
    PortableTextProps
    PortableTextReactComponents
    ProgressEvent
    PublishReleaseAction
    QueryParams
    QueryParseError
    RawQueryResponse
    ReplaceVersionAction
    RequestOptions
    ResponseEvent
    ResponseQueryOptions
    SanityProject
    SanityProjectMember
    SanityQueries
    SanityUser
    ScheduleReleaseAction
    Serializable
    SerializedBlock
    ServerSentEvent
    StegaConfig
    StoryboardTransformOptions
    ThumbnailTransformOptions
    TransformTarget
    TransformTargetInclude
    TranslateTarget
    TranslateTargetInclude
    UnarchiveReleaseAction
    UnfilteredResponseQueryOptions
    UnfilteredResponseWithoutQuery
    UnpublishVersionAction
    UnscheduleReleaseAction
    UploadClientConfig
    VideoPlaybackInfo
    VideoPlaybackInfoItemPublic
    VideoPlaybackInfoItemSigned
    VideoPlaybackTokens

    Type Aliases

    Action
    AgentActionParam
    AgentActionParams
    AgentActionPath
    AgentActionPathSegment
    AnimatedImageFormat
    AssetMetadataType
    ChannelErrorEvent
    ClientPerspective
    ClientReturn
    ContentSourceMapDocuments
    ContentSourceMapMapping
    ContentSourceMapMappings
    ContentSourceMapParsedPath
    ContentSourceMapParsedPathKeyedSegment
    ContentSourceMapPaths
    ContentSourceMapSource
    CreateAction
    CreateDataAttribute
    CreateVersionAction
    DatasetAclMode
    DatasetResponse
    DatasetsResponse
    DeleteAction
    DiscardAction
    DisconnectEvent
    DocumentAgentActionParam
    EditAction
    FieldAgentActionParam
    FilterDefault
    FitMode
    GenerateInstruction
    GenerateOperation
    GenerateTargetDocument
    HttpRequest
    HttpRequestEvent
    IdentifiedSanityDocumentStub
    ImageDescriptionOperation
    ImportReleaseAction
    InitializedStegaConfig
    ListenEvent
    ListenEventName
    ListenParams
    ListNestMode
    LiveEvent
    Logger
    MediaLibraryAssetInstanceIdentifier
    MissingComponentHandler
    Mutation
    MutationEvent
    NodeRenderer
    NodeType
    ObservablePatchBuilder
    OpenEvent
    PatchBuilder
    PatchDocument
    PatchOperation
    PatchTarget
    PortableTextBlockComponent
    PortableTextComponent
    PortableTextComponents
    PortableTextListComponent
    PortableTextListItemComponent
    PortableTextMarkComponent
    PortableTextTypeComponent
    PortableTextTypeComponentProps
    PromptRequest
    PublishAction
    QueryOptions
    QueryWithoutParams
    RawQuerylessQueryResponse
    ReactPortableTextList
    ReactPortableTextListItem
    ReconnectEvent
    ReleaseAction
    ReleaseCardinality
    ReleaseId
    ReleaseState
    ReplaceDraftAction
    ResolveStudioUrl
    SanityDocumentStub
    StackablePerspective
    StegaConfigRequiredKeys
    StillImageFormat
    StudioBaseRoute
    StudioBaseUrl
    StudioUrl
    SyncTag
    TransformDocument
    TransformOperation
    TransformTargetDocument
    TranslateDocument
    UnknownNodeType
    UnpublishAction
    UploadBody
    VersionAction
    VideoPlaybackInfoItem
    VideoPlaybackInfoPublic
    VideoPlaybackInfoSigned
    WelcomeEvent

    Variables

    createClient
    defaultComponents
    EXPERIMENTAL_API_WARNING
    requester
    unstable__adapter
    unstable__environment

    Functions

    _listen
    createDataAttribute
    defineQuery
    formatQueryParseError
    groq
    isCorsOriginError
    isHttpError
    mergeComponents
    PortableText
    stegaClean
    toPlainText

    Settings

    Member Visibility

    On This Page

    Classes
    Interfaces
    AgentActionTargetAnimatedTransformOptionsArchiveReleaseActionClientConfigConstantAgentActionParamContentSourceMapContentSourceMapDocumentContentSourceMapDocumentBaseContentSourceMapDocumentValueSourceContentSourceMapLiteralSourceContentSourceMapRemoteDocumentContentSourceMapUnknownSourceContentSourceMapValueMappingCreateDataAttributePropsCreateReleaseActionCurrentSanityUserDeleteReleaseActionDiscardVersionActionEditReleaseActionErrorPropsFilteredResponseQueryOptionsGenerateTargetGenerateTargetIncludeGroqAgentActionParamHttpErrorInitializedClientConfigListenOptionsLiveEventGoAwayLiveEventMessageLiveEventReconnectLiveEventRestartLiveEventWelcomeMediaLibraryPlaybackInfoOptionsMediaLibraryVideoPlaybackTransformationsPortableTextBlockPortableTextComponentPropsPortableTextMarkComponentPropsPortableTextPropsPortableTextReactComponentsProgressEventPublishReleaseActionQueryParamsQueryParseErrorRawQueryResponseReplaceVersionActionRequestOptionsResponseEventResponseQueryOptionsSanityProjectSanityProjectMemberSanityQueriesSanityUserScheduleReleaseActionSerializableSerializedBlockServerSentEventStegaConfigStoryboardTransformOptionsThumbnailTransformOptionsTransformTargetTransformTargetIncludeTranslateTargetTranslateTargetIncludeUnarchiveReleaseActionUnfilteredResponseQueryOptionsUnfilteredResponseWithoutQueryUnpublishVersionActionUnscheduleReleaseActionUploadClientConfigVideoPlaybackInfoVideoPlaybackInfoItemPublicVideoPlaybackInfoItemSignedVideoPlaybackTokens
    Type Aliases
    ActionAgentActionParamAgentActionParamsAgentActionPathAgentActionPathSegmentAnimatedImageFormatAssetMetadataTypeChannelErrorEventClientPerspectiveClientReturnContentSourceMapDocumentsContentSourceMapMappingContentSourceMapMappingsContentSourceMapParsedPathContentSourceMapParsedPathKeyedSegmentContentSourceMapPathsContentSourceMapSourceCreateActionCreateDataAttributeCreateVersionActionDatasetAclModeDatasetResponseDatasetsResponseDeleteActionDiscardActionDisconnectEventDocumentAgentActionParamEditActionFieldAgentActionParamFilterDefaultFitModeGenerateInstructionGenerateOperationGenerateTargetDocumentHttpRequestHttpRequestEventIdentifiedSanityDocumentStubImageDescriptionOperationImportReleaseActionInitializedStegaConfigListenEventListenEventNameListenParamsListNestModeLiveEventLoggerMediaLibraryAssetInstanceIdentifierMissingComponentHandlerMutationMutationEventNodeRendererNodeTypeObservablePatchBuilderOpenEventPatchBuilderPatchDocumentPatchOperationPatchTargetPortableTextBlockComponentPortableTextComponentPortableTextComponentsPortableTextListComponentPortableTextListItemComponentPortableTextMarkComponentPortableTextTypeComponentPortableTextTypeComponentPropsPromptRequestPublishActionQueryOptionsQueryWithoutParamsRawQuerylessQueryResponseReactPortableTextListReactPortableTextListItemReconnectEventReleaseActionReleaseCardinalityReleaseIdReleaseStateReplaceDraftActionResolveStudioUrlSanityDocumentStubStackablePerspectiveStegaConfigRequiredKeysStillImageFormatStudioBaseRouteStudioBaseUrlStudioUrlSyncTagTransformDocumentTransformOperationTransformTargetDocumentTranslateDocumentUnknownNodeTypeUnpublishActionUploadBodyVersionActionVideoPlaybackInfoItemVideoPlaybackInfoPublicVideoPlaybackInfoSignedWelcomeEvent
    Variables
    Functions