FileSessionStorage
Generated by TypeDoc. Do not edit this page directly.
Class: FileSessionStorage
Section titled “Class: FileSessionStorage”Defined in: packages/storage-file/src/index.ts:206
Extends
Section titled “Extends”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FileSessionStorage(options?): FileSessionStorage;Defined in: packages/storage-file/src/index.ts:211
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
options | FileSessionStorageOptions |
Returns
Section titled “Returns”FileSessionStorage
Overrides
Section titled “Overrides”HarnessSessionStorage.constructor
Properties
Section titled “Properties”| Property | Modifier | Type | Default value | Overrides | Defined in |
|---|---|---|---|---|---|
id | readonly | "file-session" | "file-session" | HarnessSessionStorage.id | packages/storage-file/src/index.ts:207 |
label | public | string | "File Session" | HarnessSessionStorage.label | packages/storage-file/src/index.ts:208 |
sessionsDir | readonly | string | undefined | - | packages/storage-file/src/index.ts:209 |
Methods
Section titled “Methods”createRun()
Section titled “createRun()”createRun(input): StoredRunSummary;Defined in: packages/storage-file/src/index.ts:275
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | CreateStoredRunInput |
Returns
Section titled “Returns”Overrides
Section titled “Overrides”HarnessSessionStorage.createRun
createSession()
Section titled “createSession()”createSession(input): HarnessSessionSummary;Defined in: packages/storage-file/src/index.ts:221
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | CreateStoredSessionInput |
Returns
Section titled “Returns”Overrides
Section titled “Overrides”HarnessSessionStorage.createSession
deleteSession()
Section titled “deleteSession()”deleteSession(sessionId): boolean;Defined in: packages/storage-file/src/index.ts:267
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId | string |
Returns
Section titled “Returns”boolean
Overrides
Section titled “Overrides”HarnessSessionStorage.deleteSession
getLatestRun()
Section titled “getLatestRun()”getLatestRun(sessionId): | StoredRunSummary | undefined;Defined in: packages/storage-file/src/index.ts:304
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId | string |
Returns
Section titled “Returns”| StoredRunSummary
| undefined
Overrides
Section titled “Overrides”HarnessSessionStorage.getLatestRun
getSession()
Section titled “getSession()”getSession(sessionId): | HarnessSessionSummary | undefined;Defined in: packages/storage-file/src/index.ts:242
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId | string |
Returns
Section titled “Returns”| HarnessSessionSummary
| undefined
Overrides
Section titled “Overrides”HarnessSessionStorage.getSession
init()
Section titled “init()”init(): void;Defined in: packages/storage-file/src/index.ts:216
Returns
Section titled “Returns”void
Overrides
Section titled “Overrides”listRuns()
Section titled “listRuns()”listRuns(sessionId): StoredRunSummary[];Defined in: packages/storage-file/src/index.ts:310
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
sessionId | string |
Returns
Section titled “Returns”Overrides
Section titled “Overrides”HarnessSessionStorage.listRuns
listSessions()
Section titled “listSessions()”listSessions(query?): SessionListResult;Defined in: packages/storage-file/src/index.ts:247
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
query? | SessionListQuery |
Returns
Section titled “Returns”Overrides
Section titled “Overrides”HarnessSessionStorage.listSessions
openRun()
Section titled “openRun()”openRun(input): HarnessRunStore;Defined in: packages/storage-file/src/index.ts:314
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | OpenRunStoreInput |
Returns
Section titled “Returns”Overrides
Section titled “Overrides”touchSession()
Section titled “touchSession()”touchSession(input): void;Defined in: packages/storage-file/src/index.ts:252
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
input | TouchStoredSessionInput |
Returns
Section titled “Returns”void