Class FSPersister<T>

Persists data using the node fs / path api

Type Parameters

T

Implements

IPersister<T>

Index

Constructors

Properties

filePath fileSystemAdapter key localFilesDirectory pathResolver

Accessors

Methods

Persist Purge Retrieve ensureFileExists ensureLocalFilesDirExists retrieveDataFileJson writeBlankJsonToFile

Constructors

constructor

new FSPersister<T>(localFilesDirectory, filePath, key, pathResolver, fileSystemAdapter): FSPersister<T>
Type Parameters
- T
Parameters
- localFilesDirectory: string
- filePath: string
- key: string
- pathResolver: IPathResolver
- fileSystemAdapter: IFileSystemAdapter
Returns FSPersister<T>
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:16

Properties

`Private` filePath

filePath: string

`Private` fileSystemAdapter

fileSystemAdapter: IFileSystemAdapter

`Private` key

key: string

`Private` localFilesDirectory

localFilesDirectory: string

`Private` pathResolver

pathResolver: IPathResolver

Accessors

`Private` dir

get dir(): string
Returns string
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:9

`Private` file

get file(): string
Returns string
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:12

Methods

Persist

Persist(items): void
Handles persisting the given array of objects
Parameters
- items: any[]
Returns void
Implementation of IPersister.Persist
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:32

Purge

Purge(): void
Deletes all previously persisted data

Returns void
Implementation of IPersister.Purge
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:38

Retrieve

Retrieve(): any[]
Retrieves previously persisted data as an array of objects

Returns any[]
Implementation of IPersister.Retrieve
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:27

`Private` ensureFileExists

ensureFileExists(): void
Returns void
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:48

`Private` ensureLocalFilesDirExists

ensureLocalFilesDirExists(): void
Returns void
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:42

`Private` retrieveDataFileJson

retrieveDataFileJson(): any
Returns any
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:61

`Private` writeBlankJsonToFile

writeBlankJsonToFile(): void
Returns void
- Defined in src/Persistence/Repository/Persisters/FSPersister/FSPersister.ts:56

Generated using TypeDoc