Class JSONFileDeployStore

Directory containing deploy receipts, e.g. state/$CHAIN/deploy.

Hierarchy

DeployStore
- JSONFileDeployStore

Index

Constructors

constructor

new JSONFileDeployStore(dir): JSONFileDeployStore
Parameters
- dir: string | Path
Returns JSONFileDeployStore
Overrides DeployStore.constructor
- Defined in fadroma.ts:281

Properties

KEY

KEY: string = '.active'

Name of symlink pointing to active deployment, without extension.

dir

dir: JSONDirectory<Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>>

Root directory of deploy store.

log

log: Console = ...

`Optional` selected

selected?: Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}> = undefined

Type declaration

name: string
units: {
[k: string]: T;
}
- [k: string]: T

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Accessors

[toStringTag]

get [toStringTag](): string
Returns string
Overrides DeployStore.[toStringTag]
- Defined in fadroma.ts:286

Methods

[iterator]

[iterator](): IterableIterator<[string, Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>]>
Returns an iterable of entries in the map.

Returns IterableIterator<[string, Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>]>
Inherited from DeployStore.[iterator]
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

clear

clear(): void
Returns void
Inherited from DeployStore.clear
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:21

delete

delete(key): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from DeployStore.delete
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:25

entries

entries(): IterableIterator<[string, Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[string, Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>]>
Inherited from DeployStore.entries
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:124

forEach

forEach(callbackfn, thisArg?): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value, key, map) => void)
  - - (value, key, map): void
    - Parameters
      value: Partial<{
          name: string;
          units: {
              [k: string]: T;
          };
      }>
      key: string
      map: Map<string, Partial<{
          name: string;
          units: {
              [k: string]: T;
          };
      }>>
      Returns void
- Optional thisArg: any
Returns void
Inherited from DeployStore.forEach
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:29

get

get(name): Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>
Parameters
- name: string
Returns Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>
Overrides DeployStore.get
- Defined in fadroma.ts:290

has

has(key): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from DeployStore.has
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.collection.d.ts:38

keys

keys(): IterableIterator<string>
Returns an iterable of keys in the map

Returns IterableIterator<string>
Inherited from DeployStore.keys
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

set

set(name, state): JSONFileDeployStore
Parameters
- name: string
- state: Partial<{
      name: string;
      units: {
          [k: string]: T;
      };
  }> | Partial<Deployment>
Returns JSONFileDeployStore
Overrides DeployStore.set
- Defined in fadroma.ts:300

values

values(): IterableIterator<Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>>
Returns an iterable of values in the map

Returns IterableIterator<Partial<{
    name: string;
    units: {
        [k: string]: T;
    };
}>>
Inherited from DeployStore.values
- Defined in node_modules/.pnpm/typescript@5.2.2/node_modules/typescript/lib/lib.es2015.iterable.d.ts:134

Class JSONFileDeployStore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

dir: string | Path

Returns JSONFileDeployStore

Properties

KEY

dir

log

Optional selected

Type declaration

name: string

units: { [k: string]: T; }

[k: string]: T

Readonly size

Returns

Static Readonly [species]

Accessors

[toStringTag]

Returns string

Methods

[iterator]

Returns IterableIterator<[string, Partial<{ name: string; units: { [k: string]: T; }; }>]>

clear

Returns void

delete

Parameters

key: string

Returns boolean

entries

Returns IterableIterator<[string, Partial<{ name: string; units: { [k: string]: T; }; }>]>

forEach

Parameters

callbackfn: ((value, key, map) => void)

Parameters

value: Partial<{ name: string; units: { [k: string]: T; }; }>

key: string

map: Map<string, Partial<{ name: string; units: { [k: string]: T; }; }>>

Returns void

Optional thisArg: any

Returns void

get

Parameters

name: string

Returns Partial<{ name: string; units: { [k: string]: T; }; }>

has

Parameters

key: string

Returns boolean

keys

Returns IterableIterator<string>

set

Parameters

name: string

state: Partial<{ name: string; units: { [k: string]: T; }; }> | Partial<Deployment>

Returns JSONFileDeployStore

values

Returns IterableIterator<Partial<{ name: string; units: { [k: string]: T; }; }>>

Settings

Member Visibility

Theme

On This Page

`Optional` selected

units: {
[k: string]: T;
}

`Readonly` size

`Static` `Readonly` [species]

Returns IterableIterator<[string, Partial<{
name: string;
units: {
[k: string]: T;
};
}>]>

Returns IterableIterator<[string, Partial<{
name: string;
units: {
[k: string]: T;
};
}>]>

value: Partial<{
name: string;
units: {
[k: string]: T;
};
}>

map: Map<string, Partial<{
name: string;
units: {
[k: string]: T;
};
}>>

`Optional` thisArg: any

Returns Partial<{
name: string;
units: {
[k: string]: T;
};
}>

state: Partial<{
name: string;
units: {
[k: string]: T;
};
}> | Partial<Deployment>

Returns IterableIterator<Partial<{
name: string;
units: {
[k: string]: T;
};
}>>