API reference / @chanx-js/server / testing / TestClient

Interface: TestClient

Defined in: packages/server/src/testing.ts:31

A client connected in-process by connect().

Properties

closed

readonly closed: Promise<{
  code?: number;
  reason?: string;
}>;

Defined in: packages/server/src/testing.ts:57

Resolves when the server closes the socket.

---

pending

readonly pending: readonly Frame[];

Defined in: packages/server/src/testing.ts:35

Frames received and not yet consumed by receive().

---

ready

readonly ready: Promise<boolean>;

Defined in: packages/server/src/testing.ts:33

Resolves once the server has connected this client: authenticated, groups joined.

Methods

close()

close(): Promise<void>;

Defined in: packages/server/src/testing.ts:55

Close from the client side; resolves once the server has torn the connection down.

Returns

Promise<void>

---

receive()

receive(options?): Promise<Frame>;

Defined in: packages/server/src/testing.ts:41

The next frame from the server, within a second unless told otherwise.

Parameters

Parameter	Type
options?	WaitOptions

Returns

Promise<Frame>

---

receiveAll()

receiveAll(options?): Promise<Frame[]>;

Defined in: packages/server/src/testing.ts:47

Every frame that arrives until none has for timeout ms (default 100).

Parameters

Parameter	Type
options?	WaitOptions

Returns

Promise<Frame[]>

---

receiveNothing()

receiveNothing(options?): Promise<boolean>;

Defined in: packages/server/src/testing.ts:49

Whether no frame arrives within timeout ms (default 100).

Parameters

Parameter	Type
options?	WaitOptions

Returns

Promise<boolean>

---

receiveUntil()

receiveUntil(action?, options?): Promise<Frame[]>;

Defined in: packages/server/src/testing.ts:45

Collect frames until one with this action arrives, that one included.

Parameters

Parameter	Type
action?	string
options?	WaitOptions

Returns

Promise<Frame[]>

---

request()

request(message, options?): Promise<Frame>;

Defined in: packages/server/src/testing.ts:43

Send a message with a fresh ref and resolve with the reply that echoes it.

Parameters

Parameter	Type
message	object
options?	WaitOptions & object

Returns

Promise<Frame>

---

send()

send(frame): void;

Defined in: packages/server/src/testing.ts:37

Send a raw frame, as it goes on the wire.

Parameters

Parameter	Type
frame	object

Returns

void

---

sendMessage()

sendMessage(message, options?): void;

Defined in: packages/server/src/testing.ts:39

Send a message as .create() builds it, with a ref or topic when given.

Parameters

Parameter	Type
message	Message
options?	{ ref?: string; topic?: string; }
options.ref?	string
options.topic?	string

Returns

void

---

subscribe()

subscribe(topic, options?): Promise<Frame>;

Defined in: packages/server/src/testing.ts:51

Subscribe to a topic; resolves with the server's reply.

Parameters

Parameter	Type
topic	string
options?	WaitOptions

Returns

Promise<Frame>

---

unsubscribe()

unsubscribe(topic, options?): Promise<Frame>;

Defined in: packages/server/src/testing.ts:53

Unsubscribe from a topic; resolves with the server's reply.

Parameters

Parameter	Type
topic	string
options?	WaitOptions

Returns

Promise<Frame>