Class FieldPath

constructor

• new FieldPath(base?: Iterable<string | FieldKey, any, any> | null): FieldPath

  Parameters

  • Optionalbase: Iterable<string | FieldKey, any, any> | null

  Returns FieldPath

Readonlyparts

length

• get length(): number

  Returns number

[customJson]

• "[customJson]"(): string

  Returns string

[iterator]

• "[iterator]"(): Iterator<FieldKey>

  Returns Iterator<FieldKey>

append

• append(v: string | FieldKey): this

  Parameters

  • v: string | FieldKey

  Returns this

appendMany

• appendMany(iter: Iterable<string | FieldKey>): this

  Parameters

  • iter: Iterable<string | FieldKey>

  Returns this

at

• at(i: number): FieldKey | undefined

  Parameters

  • i: number

  Returns FieldKey | undefined

concat

• concat(iter: Iterable<string | FieldKey>): FieldPath

  Parameters

  • iter: Iterable<string | FieldKey>

  Returns FieldPath

copy

• copy(): FieldPath

  Returns FieldPath

equals

• equals(other: FieldPath): boolean

  Parameters

  • other: FieldPath

  Returns boolean

isPrefixOf

• isPrefixOf(other: FieldPath): boolean

  Parameters

  • other: FieldPath

  Returns boolean

marshal

• marshal(): string

  Returns string

parent

• parent(): FieldPath | null

  Returns FieldPath | null

toMask

• toMask(): Mask

  Returns Mask

toString

• toString(): string

  Returns string

Staticfrom

• from(...parts: (string | FieldKey)[]): FieldPath

  Parameters

  • ...parts: (string | FieldKey)[]

  Returns FieldPath