Class RemoteConfigMetadata

Represent the remote config metadata object and handles:

Validation
Reading
Making a migration
Converting from and to plain object

Implements

Index

Constructors

Accessors

lastUpdateBy lastUpdatedAt migration name

Methods

makeMigration toObject validate fromObject

Constructors

constructor

new RemoteConfigMetadata(
    name: string,
    lastUpdatedAt: Date,
    lastUpdateBy: `${string}@${string}.${string}`,
    migration?: Migration,
): RemoteConfigMetadata
Parameters
- name: string
- lastUpdatedAt: Date
- lastUpdateBy: `${string}@${string}.${string}`
- Optionalmigration: Migration
Returns RemoteConfigMetadata
- Defined in solo/solo/src/core/config/remote/metadata.ts:45

Accessors

lastUpdateBy

get lastUpdateBy(): `${string}@${string}.${string}`
Retrieves the email of the user who last updated the remote config metadata

Returns `${string}@${string}.${string}`
Implementation of RemoteConfigMetadataStructure.lastUpdateBy
- Defined in solo/solo/src/core/config/remote/metadata.ts:73

lastUpdatedAt

get lastUpdatedAt(): Date
Retrieves the date when the remote config metadata was last updated

Returns Date
Implementation of RemoteConfigMetadataStructure.lastUpdatedAt
- Defined in solo/solo/src/core/config/remote/metadata.ts:68

migration

get migration(): Migration
Retrieves the migration if such exists

Returns Migration
Implementation of RemoteConfigMetadataStructure.migration
- Defined in solo/solo/src/core/config/remote/metadata.ts:78

name

get name(): string
Retrieves the namespace

Returns string
Implementation of RemoteConfigMetadataStructure.name
- Defined in solo/solo/src/core/config/remote/metadata.ts:63

Methods

makeMigration

makeMigration(email: `${string}@${string}.${string}`, fromVersion: string): void
Simplifies making a migration
Parameters
- email: `${string}@${string}.${string}`
- fromVersion: string
Returns void
- Defined in solo/solo/src/core/config/remote/metadata.ts:56

toObject

toObject(): RemoteConfigMetadataStructure
Converts the class instance to a plain object.

Returns RemoteConfigMetadataStructure
the plain object representation of the class.
Implementation of ToObject.toObject
- Defined in solo/solo/src/core/config/remote/metadata.ts:116

validate

validate(): void
Validates all properties of the class and throws if data is invalid

Returns void
Implementation of Validate.validate
- Defined in solo/solo/src/core/config/remote/metadata.ts:98

`Static`fromObject

fromObject(metadata: RemoteConfigMetadataStructure): RemoteConfigMetadata
Handles conversion from plain object to instance
Parameters
- metadata: RemoteConfigMetadataStructure
Returns RemoteConfigMetadata
- Defined in solo/solo/src/core/config/remote/metadata.ts:85