default | Machinat

Type parameters

Authenticator: AnyClientAuthenticator = AnyClientAuthenticator
Value: EventValue = EventValue

Hierarchy

ClientEmitter<ClientEventContext<Authenticator, Value | ConnectEventValue | DisconnectEventValue>>
- default

Index

Constructors

constructor

Properties

isMockupMode

Accessors

Methods

Constructors

constructor

new default<Authenticator, Value>(__namedParameters: ClientOptions<Authenticator>): default<Authenticator, Value>

Overrides ClientEmitter.constructor
- Defined in packages/webview/src/client/client.ts:63
Type parameters
- Authenticator: WebviewClientAuthenticator<unknown, unknown, AnyAuthContext, Authenticator> = AnyClientAuthenticator
- Value: EventValue<string, string, any> = EventValue<string, string, any>
Parameters
- __namedParameters: ClientOptions<Authenticator>
Returns default<Authenticator, Value>

Properties

isMockupMode

isMockupMode: boolean

Accessors

authContext

get authContext(): null | ContextOfAuthenticator<Authenticator>

- Defined in packages/webview/src/client/client.ts:55
Returns null | ContextOfAuthenticator<Authenticator>

channel

get channel(): null | WebviewConnection

- Defined in packages/webview/src/client/client.ts:51
Returns null | WebviewConnection

isClosed

get isClosed(): boolean

- Defined in packages/webview/src/client/client.ts:43
Returns boolean

isConnected

get isConnected(): boolean

- Defined in packages/webview/src/client/client.ts:39
Returns boolean

platform

get platform(): undefined | string

- Defined in packages/webview/src/client/client.ts:59
Returns undefined | string

user

get user(): null | UserOfContext<ContextOfAuthenticator<Authenticator>>

- Defined in packages/webview/src/client/client.ts:47
Returns null | UserOfContext<ContextOfAuthenticator<Authenticator>>

Methods

Protected _emitError

_emitError(err: Error): void

Inherited from ClientEmitter._emitError
- Defined in packages/websocket/src/client/ClientEmitter.ts:50
Parameters
- err: Error
Returns void

Protected _emitEvent

_emitEvent(ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>): void

Inherited from ClientEmitter._emitEvent
- Defined in packages/websocket/src/client/ClientEmitter.ts:44
Parameters
- ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>
Returns void

close

close(code?: number, reason?: string): void

- Defined in packages/webview/src/client/client.ts:108
Parameters
- Optional code: number
- Optional reason: string
Returns void

closeWebview

closeWebview(): boolean

- Defined in packages/webview/src/client/client.ts:115
Try close the webview. Return whether it's supported by current platform

Returns boolean

onError

onError(listener: (err: Error) => void): void

Inherited from ClientEmitter.onError
- Defined in packages/websocket/src/client/ClientEmitter.ts:27
Parameters
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

onEvent

onEvent(listener: (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>) => void): void

Inherited from ClientEmitter.onEvent
- Defined in packages/websocket/src/client/ClientEmitter.ts:10
Parameters
- listener: (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>) => void
  - - (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>): void
    - Parameters
      - ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>
      Returns void
Returns void

removeErrorListener

removeErrorListener(listener: (err: Error) => void): boolean

Inherited from ClientEmitter.removeErrorListener
- Defined in packages/websocket/src/client/ClientEmitter.ts:34
Parameters
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns boolean

removeEventListener

removeEventListener(listener: (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>) => void): boolean

Inherited from ClientEmitter.removeEventListener
- Defined in packages/websocket/src/client/ClientEmitter.ts:17
Parameters
- listener: (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>) => void
  - - (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>): void
    - Parameters
      - ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>
      Returns void
Returns boolean

send

send(content: EventInput | EventInput[]): Promise<void>

- Defined in packages/webview/src/client/client.ts:104
Parameters
- content: EventInput | EventInput[]
Returns Promise<void>

Type parameters

Authenticator: AnyClientAuthenticator = AnyClientAuthenticator

Value: EventValue = EventValue

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Authenticator: WebviewClientAuthenticator<unknown, unknown, AnyAuthContext, Authenticator> = AnyClientAuthenticator

Value: EventValue<string, string, any> = EventValue<string, string, any>

Parameters

__namedParameters: ClientOptions<Authenticator>

Returns default<Authenticator, Value>

Properties

isMockupMode

Accessors

authContext

Returns null | ContextOfAuthenticator<Authenticator>

channel

Returns null | WebviewConnection

isClosed

Returns boolean

isConnected

Returns boolean

platform

Returns undefined | string

user

Returns null | UserOfContext<ContextOfAuthenticator<Authenticator>>

Methods

Protected _emitError

Parameters

err: Error

Returns void

Protected _emitEvent

Parameters

ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>

Returns void

close

Parameters

Optional code: number

Optional reason: string

Returns void

closeWebview

Returns boolean

onError

Parameters

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns void

onEvent

Parameters

listener: (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>) => void

Parameters

ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>

Returns void

Returns void

removeErrorListener

Parameters

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns boolean

removeEventListener

Parameters

listener: (ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>) => void

Parameters

ctx: ClientEventContext<Authenticator, ConnectEventValue | DisconnectEventValue | Value>

Returns void

Returns boolean

send

Parameters

content: EventInput | EventInput[]

Returns Promise<void>