Class TestableAgent<TypingsSchema>

Type Parameters

TypingsSchema extends TSchema = TSchema

Hierarchy

default<TypingsSchema>
- TestableAgent

Index

Constructors

constructor

new TestableAgent<TypingsSchema extends TSchema = TSchema>(
    __namedParameters: {
        agent: Agent<TypingsSchema>;
        agentOptions: TestableAgentOptions;
    },
): TestableAgent<TypingsSchema>
Type Parameters
- TypingsSchema extends TSchema = TSchema
Parameters
- __namedParameters: { agent: Agent<TypingsSchema>; agentOptions: TestableAgentOptions }
Returns TestableAgent<TypingsSchema>
Overrides TestableAgentBase<TypingsSchema>.constructor
- Defined in agent-testing/src/testable-agent.ts:18

Properties

`Protected` `Optional`actionEndpoints

actionEndpoints?: ActionEndpointsByCollection

`Protected`httpRequester

httpRequester: HttpRequester

Methods

benchmark

benchmark(): Benchmark
Returns Benchmark
Inherited from TestableAgentBase.benchmark
- Defined in agent-testing/src/testable-agent-base.ts:10

clearPermissionOverride

clearPermissionOverride(): Promise<void>
Returns Promise<void>
Inherited from TestableAgentBase.clearPermissionOverride
- Defined in agent-client/dist/domains/remote-agent-client.d.ts:38

collection

collection(name: CollectionName<TypingsSchema>): Collection
Parameters
- name: CollectionName<TypingsSchema>
Returns Collection
Inherited from TestableAgentBase.collection
- Defined in agent-client/dist/domains/remote-agent-client.d.ts:39

distributionChart

distributionChart(chartName: string): Promise<DistributionChart>
Parameters
- chartName: string
Returns Promise<DistributionChart>
Inherited from TestableAgentBase.distributionChart
- Defined in agent-client/dist/domains/chart.d.ts:14

leaderboardChart

leaderboardChart(chartName: string): Promise<LeaderboardChart>
Parameters
- chartName: string
Returns Promise<LeaderboardChart>
Inherited from TestableAgentBase.leaderboardChart
- Defined in agent-client/dist/domains/chart.d.ts:17

`Protected`loadChart

loadChart<Type>(
chartName: string,
body?: Record<string, unknown>,
): Promise<Type>
Type Parameters
- Type
Parameters
- chartName: string
- Optionalbody: Record<string, unknown>
Returns Promise<Type>
Inherited from TestableAgentBase.loadChart
- Defined in agent-client/dist/domains/chart.d.ts:19

objectiveChart

objectiveChart(chartName: string): Promise<ObjectiveChart>
Parameters
- chartName: string
Returns Promise<ObjectiveChart>
Inherited from TestableAgentBase.objectiveChart
- Defined in agent-client/dist/domains/chart.d.ts:16

overrideActionPermission

overrideActionPermission(
    collectionName: CollectionName<TypingsSchema>,
    actionName: string,
    permissions: SmartActionPermissionsOverride,
): Promise<void>
Parameters
- collectionName: CollectionName<TypingsSchema>
- actionName: string
- permissions: SmartActionPermissionsOverride
Returns Promise<void>
Inherited from TestableAgentBase.overrideActionPermission
- Defined in agent-client/dist/domains/remote-agent-client.d.ts:37

overrideCollectionPermission

overrideCollectionPermission(
collectionName: CollectionName<TypingsSchema>,
permissions: CollectionPermissionsOverride,
): Promise<void>
Parameters
- collectionName: CollectionName<TypingsSchema>
- permissions: CollectionPermissionsOverride
Returns Promise<void>
Inherited from TestableAgentBase.overrideCollectionPermission
- Defined in agent-client/dist/domains/remote-agent-client.d.ts:36

percentageChart

percentageChart(chartName: string): Promise<number>
Parameters
- chartName: string
Returns Promise<number>
Inherited from TestableAgentBase.percentageChart
- Defined in agent-client/dist/domains/chart.d.ts:15

start

start(): Promise<void>
Returns Promise<void>
- Defined in agent-testing/src/testable-agent.ts:36

stop

stop(): Promise<void>
Returns Promise<void>
- Defined in agent-testing/src/testable-agent.ts:30

timeBasedChart

timeBasedChart(chartName: string): Promise<TimeBasedChart>
Parameters
- chartName: string
Returns Promise<TimeBasedChart>
Inherited from TestableAgentBase.timeBasedChart
- Defined in agent-client/dist/domains/chart.d.ts:18

valueChart

valueChart(chartName: string): Promise<ValueChart>
Parameters
- chartName: string
Returns Promise<ValueChart>
Inherited from TestableAgentBase.valueChart
- Defined in agent-client/dist/domains/chart.d.ts:13

Class TestableAgent<TypingsSchema>

Type Parameters

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns TestableAgent<TypingsSchema>

Properties

Protected OptionalactionEndpoints

ProtectedhttpRequester

Methods

benchmark

Returns Benchmark

clearPermissionOverride

Returns Promise<void>

collection

Parameters

Returns Collection

distributionChart

Parameters

Returns Promise<DistributionChart>

leaderboardChart

Parameters

Returns Promise<LeaderboardChart>

ProtectedloadChart

Type Parameters

Parameters

Returns Promise<Type>

objectiveChart

Parameters

Returns Promise<ObjectiveChart>

overrideActionPermission

Parameters

Returns Promise<void>

overrideCollectionPermission

Parameters

Returns Promise<void>

percentageChart

Parameters

Returns Promise<number>

start

Returns Promise<void>

stop

Returns Promise<void>

timeBasedChart

Parameters

Returns Promise<TimeBasedChart>

valueChart

Parameters

Returns Promise<ValueChart>

Settings

On This Page

`Protected` `Optional`actionEndpoints

`Protected`httpRequester

`Protected`loadChart