Class JsonDevice`Abstract`

Hierarchy (View Summary)

SimpleEventEmitter<JsonDeviceEvents>
- JsonDevice
  - Device

Index

Accessors

Constructors

Methods

addEventListener close connect dispose fireEvent log onClosed onConnectAttempt onPreConnect removeEventListener verbose warn write writeInternal

Properties

chunkSize codec connectAttempts name rxBuffer states txBuffer verboseLogging

Accessors

isClosed

get isClosed(): boolean
Returns boolean
- Defined in io/src/json-device.ts:113

isConnected

get isConnected(): boolean
Returns boolean
- Defined in io/src/json-device.ts:109

isDisposed

get isDisposed(): boolean
Returns boolean
Inherited from MidiManager.isDisposed
- Defined in events/dist/index.d.ts:12

Constructors

constructor

new JsonDevice(config?: JsonDeviceOpts): JsonDevice
Parameters
- config: JsonDeviceOpts = {}
Returns JsonDevice
Overrides SimpleEventEmitter<JsonDeviceEvents>.constructor
- Defined in io/src/json-device.ts:72

Methods

addEventListener

addEventListener<K extends keyof JsonDeviceEvents>(
    name: K,
    listener: (
        event: JsonDeviceEvents[K],
        sender: SimpleEventEmitter<JsonDeviceEvents>,
    ) => void,
): void
Adds event listener.
Type Parameters
- K extends keyof JsonDeviceEvents
  Events
Parameters
- name: K
  Event name
- listener: (
  event: JsonDeviceEvents[K],
  sender: SimpleEventEmitter<JsonDeviceEvents>,
  ) => void
  Event handler
Returns void
Throws
Error if emitter is disposed
Inherited from SimpleEventEmitter.addEventListener
- Defined in events/dist/index.d.ts:28

close

close(): Promise<void>
Returns Promise<void>
- Defined in io/src/json-device.ts:132

connect

connect(): Promise<void>
Returns Promise<void>
- Defined in io/src/json-device.ts:161

dispose

dispose(): void
Returns void
Inherited from SimpleEventEmitter.dispose
- Defined in events/dist/index.d.ts:11

`Protected`fireEvent

fireEvent<K extends keyof JsonDeviceEvents>(
type: K,
args: JsonDeviceEvents[K],
): void
Fire event
Type Parameters
- K extends keyof JsonDeviceEvents
Parameters
- type: K
  Type of event
- args: JsonDeviceEvents[K]
  Arguments for event
Returns void
Inherited from SimpleEventEmitter.fireEvent
- Defined in events/dist/index.d.ts:19

`Protected`log

log(m: string): void
Parameters
- m: string
Returns void
- Defined in io/src/json-device.ts:218

`Abstract`onClosed

onClosed(): void
Must change state

Returns void
- Defined in io/src/json-device.ts:157

`Protected` `Abstract`onConnectAttempt

onConnectAttempt(): Promise<void>
Should throw if did not succeed.

Returns Promise<void>
- Defined in io/src/json-device.ts:183

`Abstract`onPreConnect

onPreConnect(): Promise<void>
Returns Promise<void>
- Defined in io/src/json-device.ts:159

removeEventListener

removeEventListener<K extends keyof JsonDeviceEvents>(
    type: K,
    listener: (
        event: JsonDeviceEvents[K],
        sender: SimpleEventEmitter<JsonDeviceEvents>,
    ) => void,
): void
Remove event listener
Type Parameters
- K extends keyof JsonDeviceEvents
Parameters
- type: K
- listener: (
  event: JsonDeviceEvents[K],
  sender: SimpleEventEmitter<JsonDeviceEvents>,
  ) => void
Returns void
Inherited from SimpleEventEmitter.removeEventListener
- Defined in events/dist/index.d.ts:34

`Protected`verbose

verbose(m: string): void
Parameters
- m: string
Returns void
- Defined in io/src/json-device.ts:214

`Protected`warn

warn(m: unknown): void
Parameters
- m: unknown
Returns void
- Defined in io/src/json-device.ts:222

write

write(txt: string): void
Parameters
- txt: string
Returns void
- Defined in io/src/json-device.ts:117

`Protected` `Abstract`writeInternal

writeInternal(txt: string): Promise<void>
Writes text to output device
Parameters
- txt: string
Returns Promise<void>
- Defined in io/src/json-device.ts:128

Properties

chunkSize

chunkSize: number

codec

codec: Codec

connectAttempts

connectAttempts: number

name

name: string

rxBuffer

rxBuffer: StringReceiveBuffer

states

states: StateMachineWithEvents<
    Readonly<
        {
            closed: "connecting";
            connected: readonly ["closed"];
            connecting: readonly ["connected", "closed"];
            ready: "connecting";
        },
    >,
>

txBuffer

txBuffer: StringWriteBuffer

verboseLogging

verboseLogging: boolean = false

Class JsonDeviceAbstract

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

isClosed

Returns boolean

isConnected

Returns boolean

isDisposed

Returns boolean

Constructors

constructor

Parameters

Returns JsonDevice

Methods

addEventListener

Type Parameters

Parameters

Returns void

Throws

close

Returns Promise<void>

connect

Returns Promise<void>

dispose

Returns void

ProtectedfireEvent

Type Parameters

Parameters

Returns void

Protectedlog

Parameters

Returns void

AbstractonClosed

Returns void

Protected AbstractonConnectAttempt

Returns Promise<void>

AbstractonPreConnect

Returns Promise<void>

removeEventListener

Type Parameters

Parameters

Returns void

Protectedverbose

Parameters

Returns void

Protectedwarn

Parameters

Returns void

write

Parameters

Returns void

Protected AbstractwriteInternal

Parameters

Returns Promise<void>

Properties

chunkSize

codec

connectAttempts

name

rxBuffer

states

txBuffer

verboseLogging

Settings

On This Page

Class JsonDevice`Abstract`

`Protected`fireEvent

`Protected`log

`Abstract`onClosed

`Protected` `Abstract`onConnectAttempt

`Abstract`onPreConnect

`Protected`verbose

`Protected`warn

`Protected` `Abstract`writeInternal