Home > @firebase/firestore > / > doc

doc() function

Gets a DocumentReference instance that refers to a document within reference at the specified relative path.

Signature:

export declare function doc(reference: DocumentReference<unknown>, path: string, ...pathSegments: string[]): DocumentReference<DocumentData>;

Parameters

Parameter	Type	Description
reference	DocumentReference<unknown>	A reference to a Firestore document.
path	string	A slash-separated path to a document.
pathSegments	string[]	Additional path segments that will be applied relative to the first argument.

Returns:

DocumentReference<DocumentData>

The DocumentReference instance.

Exceptions

If the final path has an odd number of segments and does not point to a document.