Class Lighthouse

A connection to the lighthouse.

Hierarchy

Lighthouse

Index

Constructors

Properties

auth coder handle isClosed logger outOfOrderMessages receiveResponse receiveSingle receiveStreaming requestId responseHandlers sendRequest transport

Methods

close create delete get link list mkdir perform post put putInput putModel ready send stream streamInput streamModel unlink

Constructors

constructor

new Lighthouse(auth, transport, logger?, coder?): Lighthouse
Parameters
- auth: Auth
- transport: Transport
- Optional logger: Logger
- Optional coder: Coder
Returns Lighthouse
- Defined in out/common/lighthouse.d.ts:19

Properties

`Private` `Readonly` auth

auth: any

`Private` `Readonly` coder

coder: any

`Private` handle

handle: any

Handles a server message.

`Private` isClosed

isClosed: any

Whether the transport has been closed.

`Private` `Readonly` logger

logger: any

`Private` outOfOrderMessages

outOfOrderMessages: any

Out-of-order received messages, e.g. if a response is faster than the response handler is registered.

`Private` receiveResponse

receiveResponse: any

`Private` receiveSingle

receiveSingle: any

Receives a response for the given request id.

`Private` receiveStreaming

receiveStreaming: any

Receives a stream of responses for the given request id.

`Private` requestId

requestId: any

The current request id. Automatically increments for every request.

`Private` responseHandlers

responseHandlers: any

Handlers for response messages.

`Private` sendRequest

sendRequest: any

Sends a request.

`Private` `Readonly` transport

transport: any

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in out/common/lighthouse.d.ts:76

create

create(path): Promise<ServerMessage<unknown>>
Creates a resource at the given path. Requires CREATE permission.
Parameters
- path: string[]
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:48

delete

delete(path): Promise<ServerMessage<unknown>>
Deletes a resource at the given path. Requires DELETE permission.
Parameters
- path: string[]
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:50

get

get(path): Promise<ServerMessage<unknown>>
Gets the resource at the given path. Requires READ permission.
Parameters
- path: string[]
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:56

link

link(srcPath, destPath): Promise<ServerMessage<unknown>>
Links the given source to the given destination path. Requires WRITE permission for the destination and READ for the source.
Parameters
- srcPath: string[]
- destPath: string[]
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:58

list

list(path): Promise<ServerMessage<DirectoryTree>>
Lists the directory tree at the given path. Requires READ permission.
Parameters
- path: string[]
Returns Promise<ServerMessage<DirectoryTree>>
- Defined in out/common/lighthouse.d.ts:54

mkdir

mkdir(path): Promise<ServerMessage<unknown>>
Creates a directory at the given path. Requires CREATE permission.
Parameters
- path: string[]
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:52

perform

perform<T>(verb, path, payload?): Promise<ServerMessage<unknown>>
Performs a single request to the given path with the given payload.
Type Parameters
- T
Parameters
- verb: SingleVerb
- path: string[]
- Optional payload: T
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:62

post

post<T>(path, payload): Promise<ServerMessage<unknown>>
Combines PUT and CREATE. Requires CREATE and WRITE permission.
Type Parameters
- T
Parameters
- path: string[]
- payload: T
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:44

put

put<T>(path, payload): Promise<ServerMessage<unknown>>
Updates the resource at the given path with the given payload. Requires WRITE permission.
Type Parameters
- T
Parameters
- path: string[]
- payload: T
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:46

putInput

putInput(payload, user?): Promise<ServerMessage<unknown>>
Sends an input event to the user's input endpoint.

Note that this is the new API which not all clients may support. If your client or library does not support this, you may need to use putModel with a LegacyInputEvent.
Parameters
- payload: InputEvent
- Optional user: string
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:31

putModel

putModel(payload, user?): Promise<ServerMessage<unknown>>
Sends a frame or a legacy input event to the user's model.
Parameters
- payload: Uint8Array | LegacyInputEvent
- Optional user: string
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:23

ready

ready(): Promise<void>
A promise that resolves once ready.

Returns Promise<void>
- Defined in out/common/lighthouse.d.ts:21

send

send<P>(message): Promise<void>
Sends a client message.
Type Parameters
- P
Parameters
- message: ClientMessage<P>
Returns Promise<void>
- Defined in out/common/lighthouse.d.ts:68

stream

stream<T>(path, payload?): AsyncIterable<ServerMessage<unknown>>
Performs a streaming request to the given path with the given payload.
Type Parameters
- T
Parameters
- path: string[]
- Optional payload: T
Returns AsyncIterable<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:64

streamInput

streamInput(user?): Promise<AsyncIterable<ServerMessage<InputEvent>>>
Streams the user's input (including e.g. key/controller events).

Note that this is the new API which not all clients may support (in LUNA disabling the legacy mode will send events to this endpoint). If your client or library does not support this, you may need to streamModel and read LegacyInputEvents.
Parameters
- Optional user: string
Returns Promise<AsyncIterable<ServerMessage<InputEvent>>>
- Defined in out/common/lighthouse.d.ts:42

streamModel

streamModel(user?): Promise<AsyncIterable<ServerMessage<unknown>>>
Streams the user's model (including e.g. key/controller events).
Parameters
- Optional user: string
Returns Promise<AsyncIterable<ServerMessage<unknown>>>
- Defined in out/common/lighthouse.d.ts:33

unlink

unlink(srcPath, destPath): Promise<ServerMessage<unknown>>
Unlinks the given source from the given destination path. Requires WRITE permission for the destination.
Parameters
- srcPath: string[]
- destPath: string[]
Returns Promise<ServerMessage<unknown>>
- Defined in out/common/lighthouse.d.ts:60

Class Lighthouse

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

auth: Auth

transport: Transport

Optional logger: Logger

Optional coder: Coder

Returns Lighthouse

Properties

Private Readonly auth

Private Readonly coder

Private handle

Private isClosed

Private Readonly logger

Private outOfOrderMessages

Private receiveResponse

Private receiveSingle

Private receiveStreaming

Private requestId

Private responseHandlers

Private sendRequest

Private Readonly transport

Methods

close

Returns Promise<void>

create

Parameters

path: string[]

Returns Promise<ServerMessage<unknown>>

delete

Parameters

path: string[]

Returns Promise<ServerMessage<unknown>>

get

Parameters

path: string[]

Returns Promise<ServerMessage<unknown>>

link

Parameters

srcPath: string[]

destPath: string[]

Returns Promise<ServerMessage<unknown>>

list

Parameters

path: string[]

Returns Promise<ServerMessage<DirectoryTree>>

mkdir

Parameters

path: string[]

Returns Promise<ServerMessage<unknown>>

perform

Type Parameters

T

Parameters

verb: SingleVerb

path: string[]

Optional payload: T

Returns Promise<ServerMessage<unknown>>

post

Type Parameters

T

Parameters

path: string[]

payload: T

Returns Promise<ServerMessage<unknown>>

put

Type Parameters

T

Parameters

path: string[]

payload: T

Returns Promise<ServerMessage<unknown>>

putInput

Parameters

`Optional` logger: Logger

`Optional` coder: Coder

`Private` `Readonly` auth

`Private` `Readonly` coder

`Private` handle

`Private` isClosed

`Private` `Readonly` logger

`Private` outOfOrderMessages

`Private` receiveResponse

`Private` receiveSingle

`Private` receiveStreaming

`Private` requestId

`Private` responseHandlers

`Private` sendRequest

`Private` `Readonly` transport

`Optional` payload: T

`Optional` user: string

`Optional` user: string

`Optional` payload: T

`Optional` user: string

`Optional` user: string