Class SyncYamlFileAdapter

SyncYamlFileAdapter is an sync adapter for working with Yaml Files

author: Nicolas Schmidt <@nsc-de>

Hierarchy

SyncYamlFileAdapter

Implements

SyncDatabaseAdapter

Index

Constructors

constructor

Properties

path

Methods

load
save

Constructors

constructor

new SyncYamlFileAdapter(path: string): SyncYamlFileAdapter

- Defined in yaml_adapter.ts:94
The constructor for SyncYamlFileAdapter

author

Nicolas Schmidt <@nsc-de>

see

SyncYamlFileAdapter - 👩‍👦 the parent class

Parameters
- path: string
  
  the path to a yaml file to save to and load from
Returns SyncYamlFileAdapter

Properties

Readonly path

path: string

the path to a yaml file to save to and load from

Methods

load

load(): JSObject

Implementation of SyncDatabaseAdapter.load
- Defined in yaml_adapter.ts:133
Loads data from the file the adapter refers to

author

Nicolas Schmidt <@nsc-de>

see

SyncYamlFileAdapter - 👩‍👦 the parent class

Returns JSObject

⌛ Promise (Ready when saved) >> Object

save

save(data: JSObject): void

Implementation of SyncDatabaseAdapter.save
- Defined in yaml_adapter.ts:119
Saves the given data to the file the adapter refers to

author

Nicolas Schmidt <@nsc-de>

see

SyncYamlFileAdapter - 👩‍👦 the parent class

Parameters
- data: JSObject
  
  The data to save
Returns void

⌛ Promise (Ready when saved) >> ⛔ void

Generated using TypeDoc