Reference
Type Aliases
Arg
type Arg =
| ArrayArg
| ObjectArg;Defined in: index.ts:3
ArrayArg
type ArrayArg = unknown[];Defined in: index.ts:1
Character
type Character =
| typeof Characters[keyof typeof Characters]
| string & object;Defined in: index.ts:23
ObjectArg
type ObjectArg = Record<PropertyKey, unknown>;Defined in: index.ts:2
Part
type Part = typeof Parts[keyof typeof Parts];Defined in: index.ts:33
Variables
Characters
const Characters: object;Defined in: index.ts:15
Type declaration
| Name | Type | Default value |
|---|---|---|
Dot | "." | '.' |
Empty | "" | '' |
Escape | "\" | '\' |
LeftBracket | "[" | '[' |
RightBracket | "]" | ']' |
Parts
const Parts: object;Defined in: index.ts:26
Type declaration
| Name | Type | Default value |
|---|---|---|
Index | "index" | 'index' |
IndexEnd | "indexEnd" | 'indexEnd' |
Property | "property" | 'property' |
Start | "start" | 'start' |
Functions
del()
function del(object, path): booleanDefined in: index.ts:275
Parameters
| Parameter | Type |
|---|---|
object | Arg |
path | string |
Returns
boolean
get()
function get(
ogObject,
path,
defaultValue?): unknownDefined in: index.ts:211
Parameters
| Parameter | Type |
|---|---|
ogObject | Arg |
path | string |
defaultValue? | unknown |
Returns
unknown
has()
function has(object, path): booleanDefined in: index.ts:300
Parameters
| Parameter | Type |
|---|---|
object | Arg |
path | string |
Returns
boolean
set()
function set<T>(
object,
path,
value): TDefined in: index.ts:246
Type Parameters
| Type Parameter |
|---|
T extends Arg |
Parameters
| Parameter | Type |
|---|---|
object | T |
path | string |
value | unknown |
Returns
T