Modules | @vltpkg/dot-prop

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:34

Variables

Characters

const Characters: object

Type declaration

Dot

readonly Dot: "." = '.';

Empty

readonly Empty: "" = '';

Escape

readonly Escape: "\" = '\';

LeftBracket

readonly LeftBracket: "[" = '[';

RightBracket

readonly RightBracket: "]" = ']';

Defined in

index.ts:15

---

Parts

const Parts: object

Type declaration

Index

readonly Index: "index" = 'index';

IndexEnd

readonly IndexEnd: "indexEnd" = 'indexEnd';

Property

readonly Property: "property" = 'property';

Start

readonly Start: "start" = 'start';

Defined in

index.ts:27

Functions

del()

function del(object, path): boolean

Parameters

• object: Arg

• path: string

Returns

boolean

Defined in

index.ts:276

---

get()

function get(ogObject, path, defaultValue?): unknown

Parameters

• ogObject: Arg

• path: string

• defaultValue?: unknown

Returns

unknown

Defined in

index.ts:212

---

has()

function has(object, path): boolean

Parameters

• object: Arg

• path: string

Returns

boolean

Defined in

index.ts:301

---

set()

function set<T>(object, path, value): T

Type Parameters

• T extends Arg

Parameters

• object: T

• path: string

• value: unknown

Returns

T

Defined in

index.ts:247