@vltpkg/vlt-json

Type Aliases

Validator()<T>

type Validator<T> = (x, file) => asserts x is T

Defined in: index.ts:102

Type Parameters

• T

Parameters

x

unknown

file

string

Returns

asserts x is T

---

WhichConfig

type WhichConfig = 'user' | 'project'

Defined in: index.ts:24

Functions

find()

function find(which, cwd, home): string

Defined in: index.ts:155

Parameters

which

WhichConfig = 'project'

cwd

string = ...

home

string = ...

Returns

string

---

load()

function load<T>(field, validator, which): undefined | T

Defined in: index.ts:142

Type Parameters

• T

Parameters

field

string

validator

Validator<T>

which

WhichConfig = 'project'

Returns

undefined | T

---

reload()

function reload(field, which): unknown

Defined in: index.ts:128

Parameters

field

string

which

WhichConfig = 'project'

Returns

unknown

---

save()

function save(field, value, which): void

Defined in: index.ts:190

Parameters

field

string

value

unknown

which

WhichConfig = 'project'

Returns

void

---

unload()

function unload(which): void

Defined in: index.ts:120

This should only be used in tests

Parameters

which

WhichConfig = 'project'

Returns

void