Class Path

Holds a more details version of a path information. This object is readonly

Some segments have special meanings listed in SpecialSegments

Index

Accessors

depth documentDepth isCollection isDocument isEmpty isRoot isSubcollection lastSegment path pathToDeepestCollection segments

Methods

fromPathLike fromSegments fromString merge

Accessors

depth

get depth(): number
The amount of segments composing the path

Returns number
- Defined in packages/firestorm/src/core/path/path.ts:65

documentDepth

get documentDepth(): number
The amount of full collection-document in the path

Returns number
- Defined in packages/firestorm/src/core/path/path.ts:58

isCollection

get isCollection(): boolean
If the path would land on a collection

Returns boolean
- Defined in packages/firestorm/src/core/path/path.ts:79

isDocument

get isDocument(): boolean
If the path would land on a document

Returns boolean
- Defined in packages/firestorm/src/core/path/path.ts:86

isEmpty

get isEmpty(): boolean
If there is no path

Returns boolean
- Defined in packages/firestorm/src/core/path/path.ts:51

isRoot

get isRoot(): boolean
If no collection-document couple is complete in the path

Returns boolean
- Defined in packages/firestorm/src/core/path/path.ts:72

isSubcollection

get isSubcollection(): boolean
If the path would land on a collection that isn't a root collection

Returns boolean
- Defined in packages/firestorm/src/core/path/path.ts:93

lastSegment

get lastSegment(): string
Gets the last segment of the path

Returns string
- Defined in packages/firestorm/src/core/path/path.ts:100

path

get path(): string
String representing the path

Returns string
- Defined in packages/firestorm/src/core/path/path.ts:44

pathToDeepestCollection

get pathToDeepestCollection(): string
Gets the path to the deepest collection this path can reach

Returns string
- Defined in packages/firestorm/src/core/path/path.ts:115

segments

get segments(): readonly string[]
Gets all the segments in the path

Returns readonly string[]
- Defined in packages/firestorm/src/core/path/path.ts:108

Methods

`Static`fromPathLike

fromPathLike(pathLike: PathLike | undefined): Path
Converts the given object to path
Parameters
- pathLike: PathLike | undefined
  Object to convert
Returns Path
The path built
- Defined in packages/firestorm/src/core/path/path.ts:166

`Static`fromSegments

fromSegments(segments: string[]): Path
Build a Path object from its segmented representation
Parameters
- segments: string[]
  Segmented representation of the path
Returns Path
The path
- Defined in packages/firestorm/src/core/path/path.ts:157

`Static`fromString

fromString(pathString: string): Path
Build a Path object from its string representation
Parameters
- pathString: string
  String representation of the path
Returns Path
The path
- Defined in packages/firestorm/src/core/path/path.ts:142

`Static`merge

merge(...pathLikes: PathLike[]): Path
Merges multiple path into one
Parameters
- ...pathLikes: PathLike[]
  List of paths to merge.
Returns Path
The merged paths
- Defined in packages/firestorm/src/core/path/path.ts:193