@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

Defined in: index.ts:15

Type declaration

Dot

readonly Dot: "." = '.';

Empty

readonly Empty: "" = '';

Escape

readonly Escape: "\" = '\';

LeftBracket

readonly LeftBracket: "[" = '[';

RightBracket

readonly RightBracket: "]" = ']';

---

Parts

const Parts: object

Defined in: index.ts:27

Type declaration

Index

readonly Index: "index" = 'index';

IndexEnd

readonly IndexEnd: "indexEnd" = 'indexEnd';

Property

readonly Property: "property" = 'property';

Start

readonly Start: "start" = 'start';

Functions

del()

function del(object, path): boolean

Defined in: index.ts:276

Parameters

object

Arg

path

string

Returns

boolean

---

get()

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

Defined in: index.ts:212

Parameters

ogObject

Arg

path

string

defaultValue?

unknown

Returns

unknown

---

has()

function has(object, path): boolean

Defined in: index.ts:301

Parameters

object

Arg

path

string

Returns

boolean

---

set()

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

Defined in: index.ts:247

Type Parameters

• T extends Arg

Parameters

object

T

path

string

value

unknown

Returns

T