LogoRobo.js
Packages@robojs/mock

ISession

Interface: ISession

Represents an isolated test session with its own state

Properties

PropertyModifierType
config?publicSessionConfig
connectionspublicMap<string, ConnectionState>
createdAtpublicnumber
expiresAtpublicnumber
idpublicstring
isEndingreadonlyboolean
isExpiredreadonlyboolean
name?publicstring
recorderreadonlyIActionRecorder
scenarioManagerreadonlyIScenarioManager
statepublicSessionState
tokenpublicstring

Methods

checkRateLimit()

checkRateLimit(): 
  | null
  | {
  retryAfter: number;
}

Returns

| null | { retryAfter: number; }


clearActionContext()

clearActionContext(): void

Returns

void


clearActions()

clearActions(): void

Returns

void


clearLogs()

clearLogs(): void

Returns

void


dispatch()

dispatch(event, data): Promise<void>

Parameters

ParameterType
eventstring
dataunknown

Returns

Promise<void>


exportRecording()

exportRecording(): SessionRecording

Returns

SessionRecording


getActionContext()

getActionContext(): null | ActionContext

Returns

null | ActionContext


getActions()

getActions(): RecordedAction[]

Returns

RecordedAction[]


getActionsByType()

getActionsByType(type): RecordedAction[]

Parameters

ParameterType
typeActionType

Returns

RecordedAction[]


getActionsSince()

getActionsSince(timestamp): RecordedAction[]

Parameters

ParameterType
timestampnumber

Returns

RecordedAction[]


getDispatches()

getDispatches(): RecordedAction[]

Returns

RecordedAction[]


getGatewayMessages()

getGatewayMessages(): RecordedAction[]

Returns

RecordedAction[]


getInteractionResponses()

getInteractionResponses(): RecordedAction[]

Returns

RecordedAction[]


getLogs()

getLogs(): SessionLogEntry[]

Returns

SessionLogEntry[]


getLogsSince()

getLogsSince(timestamp): SessionLogEntry[]

Parameters

ParameterType
timestampnumber

Returns

SessionLogEntry[]


getMessagesSent()

getMessagesSent(): RecordedAction[]

Returns

RecordedAction[]


getRestRequests()

getRestRequests(): RecordedAction[]

Returns

RecordedAction[]


recordAction()

recordAction(
   type, 
   data, 
   options?): RecordedAction

Parameters

ParameterType
typeActionType
dataunknown
options?RecordActionOptions

Returns

RecordedAction


recordLog()

recordLog(entry): SessionLogEntry

Parameters

ParameterType
entryOmit<SessionLogEntry, "id">

Returns

SessionLogEntry


reset()

reset(): void

Returns

void


setActionContext()

setActionContext(context): void

Parameters

ParameterType
contextnull | ActionContext

Returns

void


setRateLimitSimulation()

setRateLimitSimulation(enabled, retryAfter?): void

Parameters

ParameterType
enabledboolean
retryAfter?number

Returns

void


startAutoArchive()

startAutoArchive(intervalMs?): void

Parameters

ParameterType
intervalMs?number

Returns

void


stopAutoArchive()

stopAutoArchive(): void

Returns

void

On this page