vlt / docs

  • PricingBenchmarks (opens in new window)Community (opens in new window)Feedback
  • Overview
    • Overview
    • Reference
  • Classes
  • Keychain<V>
  1. Client
  2. /
  3. API Reference
  4. /
  5. @vltpkg/keychain
  6. /
  7. Reference

Reference

Classes

Keychain<V>

Defined in: index.ts:8

Type Parameters

Type ParameterDefault type
V extends stringstring

Constructors

new Keychain()
TypeScript
new Keychain<V>(application): Keychain<V>

Defined in: index.ts:15

Parameters
ParameterType
applicationstring
Returns

Keychain<V>

Accessors

dirty
Get Signature
TypeScript
get dirty(): boolean

Defined in: index.ts:23

Returns

boolean

file
Get Signature
TypeScript
get file(): string

Defined in: index.ts:20

Returns

string

Methods

delete()
TypeScript
delete(key): void

Defined in: index.ts:91

Parameters
ParameterType
keystring
Returns

void

get()
TypeScript
get(key): Promise<undefined | V>

Defined in: index.ts:27

Parameters
ParameterType
keystring
Returns

Promise<undefined | V>

getSync()
TypeScript
getSync(key): undefined | V

Defined in: index.ts:31

Parameters
ParameterType
keystring
Returns

undefined | V

has()
TypeScript
has(key): Promise<boolean>

Defined in: index.ts:54

Parameters
ParameterType
keystring
Returns

Promise<boolean>

hasSync()
TypeScript
hasSync(key): boolean

Defined in: index.ts:58

Parameters
ParameterType
keystring
Returns

boolean

keys()
TypeScript
keys(): Promise<string[]>

Defined in: index.ts:62

Returns

Promise<string[]>

keysSync()
TypeScript
keysSync(): string[]

Defined in: index.ts:66

Returns

string[]

load()
TypeScript
load(): Promise<void>

Defined in: index.ts:35

Returns

Promise<void>

save()
TypeScript
save(): Promise<void>

Defined in: index.ts:107

Returns

Promise<void>

set()
TypeScript
set(key, value): void

Defined in: index.ts:86

Parameters
ParameterType
keystring
valueV
Returns

void


Previous@vltpkg/keychainNext@vltpkg/output

On this page

  • Classes
  • Keychain<V>

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