Packages@robojs/mock
ISession
Interface: ISession
Represents an isolated test session with its own state
Properties
| Property | Modifier | Type |
|---|---|---|
config? | public | SessionConfig |
connections | public | Map<string, ConnectionState> |
createdAt | public | number |
expiresAt | public | number |
id | public | string |
isEnding | readonly | boolean |
isExpired | readonly | boolean |
name? | public | string |
recorder | readonly | IActionRecorder |
scenarioManager | readonly | IScenarioManager |
state | public | SessionState |
token | public | string |
Methods
checkRateLimit()
checkRateLimit():
| null
| {
retryAfter: number;
}Returns
| null
| {
retryAfter: number;
}
clearActionContext()
clearActionContext(): voidReturns
void
clearActions()
clearActions(): voidReturns
void
clearLogs()
clearLogs(): voidReturns
void
dispatch()
dispatch(event, data): Promise<void>Parameters
| Parameter | Type |
|---|---|
event | string |
data | unknown |
Returns
Promise<void>
exportRecording()
exportRecording(): SessionRecordingReturns
getActionContext()
getActionContext(): null | ActionContextReturns
null | ActionContext
getActions()
getActions(): RecordedAction[]Returns
getActionsByType()
getActionsByType(type): RecordedAction[]Parameters
| Parameter | Type |
|---|---|
type | ActionType |
Returns
getActionsSince()
getActionsSince(timestamp): RecordedAction[]Parameters
| Parameter | Type |
|---|---|
timestamp | number |
Returns
getDispatches()
getDispatches(): RecordedAction[]Returns
getGatewayMessages()
getGatewayMessages(): RecordedAction[]Returns
getInteractionResponses()
getInteractionResponses(): RecordedAction[]Returns
getLogs()
getLogs(): SessionLogEntry[]Returns
SessionLogEntry[]
getLogsSince()
getLogsSince(timestamp): SessionLogEntry[]Parameters
| Parameter | Type |
|---|---|
timestamp | number |
Returns
SessionLogEntry[]
getMessagesSent()
getMessagesSent(): RecordedAction[]Returns
getRestRequests()
getRestRequests(): RecordedAction[]Returns
recordAction()
recordAction(
type,
data,
options?): RecordedActionParameters
| Parameter | Type |
|---|---|
type | ActionType |
data | unknown |
options? | RecordActionOptions |
Returns
recordLog()
recordLog(entry): SessionLogEntryParameters
| Parameter | Type |
|---|---|
entry | Omit<SessionLogEntry, "id"> |
Returns
SessionLogEntry
reset()
reset(): voidReturns
void
setActionContext()
setActionContext(context): voidParameters
| Parameter | Type |
|---|---|
context | null | ActionContext |
Returns
void
setRateLimitSimulation()
setRateLimitSimulation(enabled, retryAfter?): voidParameters
| Parameter | Type |
|---|---|
enabled | boolean |
retryAfter? | number |
Returns
void
startAutoArchive()
startAutoArchive(intervalMs?): voidParameters
| Parameter | Type |
|---|---|
intervalMs? | number |
Returns
void
stopAutoArchive()
stopAutoArchive(): voidReturns
void
