Options
All
  • Public
  • Public/Protected
  • All
Menu

Module Lists/Paths/parsePath

Index

Functions

Functions

parsePath

  • This function can be used to convert a string into a path array. It will also validate already existing path arrays.

    By default a period (.) is used to separate path parts like: "my.array.path" => ["my","array","path"]. If you require another separator you can set another one by using the separator parameter. In most circumstances it will make more sense just to escape a separator, tho. Do that by using a backslash like: "my\.array.path" => ["my.array", "path"].

    Parameters

    • path: ListPath

      The path to parse as described above.

    • Optional separator: string

      Default: "." Can be set to any string you want to use as separator of path parts.

    Returns TListPathArray

Generated using TypeDoc