Document UID types

can.ural · December 20, 2022, 9:05am

Is there any reason for document uid to be string | null and not just string?

jake · December 20, 2022, 6:32pm

Hey, welcome!

Some documents will not have a UID in the object and a null type is required.

prismicio/prismic-types/blob/702fdadd4ce264a707c5e16b1b172ea328b5de82/src/value/document.ts#L96-L118


      
          * A Prismic document served through REST API v2. Does not contain a UID (a
          * unique identifier).
          *
          * @see More details on Custom Types: {@link https://prismic.io/docs/technologies/introduction-to-the-content-query-api}
          * @see More details on the UID field: {@link https://prismic.io/docs/core-concepts/uid}
          */
          export interface PrismicDocumentWithoutUID<
          	DataInterface extends Record<
          		string,
          		AnyRegularField | GroupField | SliceZone
          		// eslint-disable-next-line @typescript-eslint/no-explicit-any
          	> = Record<string, any>,
          	TypeEnum = string,
          	LangEnum = string,
          > extends PrismicDocument<DataInterface, TypeEnum, LangEnum> {
          	/**
          	 * This document does not have a UID field. This property will always be
          	 * `null`.
          	 *
          	 * The unique identifier for the document. Guaranteed to be unique among all

This file has been truncated. show original

Topic		Replies	Views
Is there any difference between a document's UID versus ID? Developing with Prismic typescript , rest-api	1	1267	April 14, 2023
UID not set in my entries Prismic for Content Creators	7	566	May 26, 2022
Uid type not being generated by slicemachine Developing with Prismic typescript	5	227	January 6, 2023
500 error exception Developing with Prismic rest-api	4	986	December 9, 2021
getByUID gives wrong document? Developing with Prismic ruby	5	669	December 9, 2021

Document UID types

Related Topics