vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • Reference
  • Type Aliases
  • Arg
  • ArrayArg
  • Character
  • ObjectArg
  • Part
  • Variables
  • Characters
  • Parts
  • Functions
  • del()
  • get()
  • has()
  • set()
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/dot-prop
  6. /
  7. Reference

Reference

Type Aliases

Arg

TypeScript
type Arg = 
  | ArrayArg
  | ObjectArg;

Defined in: index.ts:3


ArrayArg

TypeScript
type ArrayArg = unknown[];

Defined in: index.ts:1


Character

TypeScript
type Character = 
  | typeof Characters[keyof typeof Characters]
  | string & object;

Defined in: index.ts:23


ObjectArg

TypeScript
type ObjectArg = Record<PropertyKey, unknown>;

Defined in: index.ts:2


Part

TypeScript
type Part = typeof Parts[keyof typeof Parts];

Defined in: index.ts:33

Variables

Characters

TypeScript
const Characters: object;

Defined in: index.ts:15

Type declaration

NameTypeDefault value
Dot"."'.'
Empty""''
Escape"\"'\'
LeftBracket"["'['
RightBracket"]"']'

Parts

TypeScript
const Parts: object;

Defined in: index.ts:26

Type declaration

NameTypeDefault value
Index"index"'index'
IndexEnd"indexEnd"'indexEnd'
Property"property"'property'
Start"start"'start'

Functions

del()

TypeScript
function del(object, path): boolean

Defined in: index.ts:275

Parameters

ParameterType
objectArg
pathstring

Returns

boolean


get()

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

Defined in: index.ts:211

Parameters

ParameterType
ogObjectArg
pathstring
defaultValue?unknown

Returns

unknown


has()

TypeScript
function has(object, path): boolean

Defined in: index.ts:300

Parameters

ParameterType
objectArg
pathstring

Returns

boolean


set()

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

Defined in: index.ts:246

Type Parameters

Type Parameter
T extends Arg

Parameters

ParameterType
objectT
pathstring
valueunknown

Returns

T


Previous@vltpkg/dot-propNext@vltpkg/dss-breadcrumb

On this page

  • Type Aliases
  • Arg
  • ArrayArg
  • Character
  • ObjectArg
  • Part
  • Variables
  • Characters
  • Parts
  • Functions
  • del()
  • get()
  • has()
  • set()

Deploy your package on vlt.io

Publish scoped and private packages, manage organizations and access, and give every developer and CI environment a consistent source for public and private JavaScript dependencies.

Publish now