@my-swu/simulator-client

---

@my-swu/simulator-client / SimulatorClientOptions

Interface: SimulatorClientOptions

Defined in: packages/ts-sdk/src/client.ts:35

Constructor options for the simulator client.

baseUrl points at the HTTP origin for the simulator server. The SDK derives /api/*, /health, and the matching /ws socket origin from this value.

Example:

import type { SimulatorClientOptions } from '@my-swu/simulator-client'

const simulatorClientOptions: SimulatorClientOptions = { baseUrl: 'http://127.0.0.1:4000' }

console.log(simulatorClientOptions)

Example

import { createSimulatorClient } from '@my-swu/simulator-client'

const simulatorClient = createSimulatorClient({
  baseUrl: 'http://127.0.0.1:4000',
})

console.log(await simulatorClient.system.health())

See

• https://simulator-sdk.my-swu.com/guide/getting-started
• https://simulator-sdk.my-swu.com/guide/runtime-adapters

Properties

baseUrl

Example:

import type { SimulatorClientOptions } from '@my-swu/simulator-client'

const simulatorClientOptions: SimulatorClientOptions = { baseUrl: 'http://127.0.0.1:4000' }

const { baseUrl: simulatorBaseUrl } = simulatorClientOptions

console.log(simulatorBaseUrl)

baseUrl: string

Defined in: packages/ts-sdk/src/client.ts:40

Base URL of the simulator HTTP API, for example http://127.0.0.1:4000. The trailing slash is optional.

---

fetch?

Example:

import type { SimulatorClientOptions } from '@my-swu/simulator-client'

const simulatorClientOptions: SimulatorClientOptions = { baseUrl: 'http://127.0.0.1:4000' }

const { fetch } = simulatorClientOptions

console.log(fetch)

optional fetch?: {(input, init?): Promise<Response>; (input, init?): Promise<Response>; }

Defined in: packages/ts-sdk/src/client.ts:44

Optional fetch implementation. Defaults to the global fetch when available.

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

URL | RequestInfo

init?

RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>

MDN Reference

Parameters

input

string | URL | Request

init?

RequestInit

Returns

Promise<Response>

---

webSocketFactory?

Example:

import type { SimulatorClientOptions } from '@my-swu/simulator-client'

const simulatorClientOptions: SimulatorClientOptions = { baseUrl: 'http://127.0.0.1:4000' }

const { webSocketFactory } = simulatorClientOptions

console.log(webSocketFactory)

optional webSocketFactory?: WebSocketFactory

Defined in: packages/ts-sdk/src/client.ts:48

Optional WebSocket factory. Defaults to the global WebSocket when available.