Function toPathString

toPathString<T = unknown>(
path: string | readonly T[],
options?: { extraKey?: unknown; notation?: "mixed" | "bracket" },
): string
Converts a path into a readable string with bracket or mixed notation.
Type Parameters
- T = unknown
Parameters
- path: string | readonly T[]
  Path as array or string.
- Optionaloptions: { extraKey?: unknown; notation?: "mixed" | "bracket" }
  Options for more precision.
  - OptionalextraKey?: unknown
    Optional extra key to append to the path string.
  - Optionalnotation?: "mixed" | "bracket"
    The notation in which the path and/or the extra key string will be created.
Returns string
String representation of the path.
Remarks
- Uses toSimpleString for stringify keys.
- If the path is a string, it is returned as is or the extra key is added.
Throws
TypeError if some argument is invalid.
Example
```
const path = [ "a", "b", "c", 0 ];
toPathString(path, { notation: "mixed" })     // "a.b.c[0]"
toPathString(path, { notation: "bracket" })   // '["a"]["b"]["c"][0]'
toPathString(path, { extraKey: "d" })         // "a.b.c[0].d"
toPathString("a.b", { notation: "bracket" })  // "a.b"
```
Since
3.0.0-beta.3
- Defined in utils/public/to-string/for-paths.ts:56

Index

Properties

Properties

notation

notation: "mixed" | "bracket"

The notation in which the path and/or the extra key string will be created.

Since

3.0.0-beta.3