function

Populated

Populated snapshots the document and derives the reference ID from it, preventing contradictory caller-supplied ID/document pairs.

Arguments

ArgumentTypeDescription
documentstore.DocumentThe document value.

Returns

The declared result.

ReferenceOutput

Full signature

Related types

  • Document

    A stored document with status and version metadata.

  • ReferenceOutput

    ReferenceOutput is the logical read value of a singular relationship. ID is available regardless of whether an authorized document was populated.