Interface ToDocumentRelationshipMetadata<T>

Relationship metadata. A relationship is a link from the current document to other documents.

interface ToDocumentRelationshipMetadata<T extends FirestormModel> {
    documentId: string;
    kind: "document";
    location: PathLike;
    targetType: Type<T>;
}

Type Parameters

T extends FirestormModel

Hierarchy (View Summary)

RelationshipMetadata<T>
- ToDocumentRelationshipMetadata

Index

Properties

documentId kind location targetType

Properties

documentId

documentId: string

Id of the document

kind

kind: "document"

The kind of relationship

location

location: PathLike

Location of the relationship relative to the current document

targetType

targetType: Type<T>

Target type of the relationship