Class Message<T>

Representation of a set of fields sequenced into a known message format.

Type Parameters

T extends MessageType = MessageType

Hierarchy

Message

Index

Constructors

constructor

new Message<T>(__namedParameters: Options<T>): Message<T>
Type Parameters
- T extends MessageType = MessageType
Parameters
- __namedParameters: Options<T>
Returns Message<T>
- Defined in src/remotedb/message/index.ts:140

Properties

`Readonly` args

args: Field[]

`Optional` transactionId

transactionId?: number

The transaction ID is used to associate responses to their requests.

`Readonly` type

type: T

Accessors

buffer

get buffer(): Buffer
The byte serialization of the message

Returns Buffer
- Defined in src/remotedb/message/index.ts:149

data

get data(): ReturnType<{
    16384: ((args: Field[]) => {
        itemsAvailable: number;
    });
    16385: ((_args: Field[]) => null);
    16386: ((args: Field[]) => Buffer);
    16387: ((_args: Field[]) => null);
    16641: ((args: Field[]) => Item<Path> | Item<Folder> | Item<AlbumTitle> | Item<Disc> | Item<TrackTitle> | Item<Genre> | Item<Artist> | Item<Playlist> | Item<Rating> | Item<Duration> | Item<Tempo> | Item<Label> | Item<Key> | Item<BitRate> | Item<Year> | Item<Comment> | Item<HistoryPlaylist> | Item<OrigianlArtist> | Item<Remixer> | Item<DateAdded> | Item<ColorNone> | Item<ColorPink> | Item<ColorRed> | Item<ColorOrange> | Item<ColorYellow> | Item<ColorGreen> | Item<ColorAqua> | Item<ColorBlue> | Item<ColorPurple> | Item<MenuGenre> | Item<MenuArtist> | Item<MenuAlbum> | Item<MenuTrack> | Item<MenuPlaylist> | Item<MenuBPM> | Item<MenuRating> | Item<MenuYear> | Item<MenuRemixer> | Item<MenuLabel> | Item<MenuOriginal> | Item<MenuKey> | Item<MenuColor> | Item<MenuFolder> | Item<MenuSearch> | Item<MenuTime> | Item<MenuBit> | Item<MenuFilename> | Item<MenuHistory> | Item<MenuAll> | Item<TrackTitleAlbum> | Item<TrackTitleGenre> | Item<TrackTitleArtist> | Item<TrackTitleRating> | Item<TrackTitleTime> | Item<TrackTitleBPM> | Item<TrackTitleLabel> | Item<TrackTitleKey> | Item<TrackTitleBitRate> | Item<TrackTitleColor> | Item<TrackTitleComment> | Item<TrackTitleOriginalArtist> | Item<TrackTitleRemixer> | Item<TrackTitleDJPlayCount> | Item<MenuTrackTitleDateAdded>);
    16897: ((_args: Field[]) => null);
    17410: ((args: Field[]) => WaveformPreview);
    17922: ((args: Field[]) => BeatGrid);
    18178: ((args: Field[]) => CueAndLoop[]);
    18946: ((args: Field[]) => WaveformDetailed);
    19970: ((args: Field[]) => CueAndLoop[]);
    20226: ((args: Field[]) => WaveformHD);
}[ResponseType<T>]>
The JS representation of the message.

Currently only supports representing response messages.

Returns ReturnType<{
    16384: ((args: Field[]) => {
        itemsAvailable: number;
    });
    16385: ((_args: Field[]) => null);
    16386: ((args: Field[]) => Buffer);
    16387: ((_args: Field[]) => null);
    16641: ((args: Field[]) => Item<Path> | Item<Folder> | Item<AlbumTitle> | Item<Disc> | Item<TrackTitle> | Item<Genre> | Item<Artist> | Item<Playlist> | Item<Rating> | Item<Duration> | Item<Tempo> | Item<Label> | Item<Key> | Item<BitRate> | Item<Year> | Item<Comment> | Item<HistoryPlaylist> | Item<OrigianlArtist> | Item<Remixer> | Item<DateAdded> | Item<ColorNone> | Item<ColorPink> | Item<ColorRed> | Item<ColorOrange> | Item<ColorYellow> | Item<ColorGreen> | Item<ColorAqua> | Item<ColorBlue> | Item<ColorPurple> | Item<MenuGenre> | Item<MenuArtist> | Item<MenuAlbum> | Item<MenuTrack> | Item<MenuPlaylist> | Item<MenuBPM> | Item<MenuRating> | Item<MenuYear> | Item<MenuRemixer> | Item<MenuLabel> | Item<MenuOriginal> | Item<MenuKey> | Item<MenuColor> | Item<MenuFolder> | Item<MenuSearch> | Item<MenuTime> | Item<MenuBit> | Item<MenuFilename> | Item<MenuHistory> | Item<MenuAll> | Item<TrackTitleAlbum> | Item<TrackTitleGenre> | Item<TrackTitleArtist> | Item<TrackTitleRating> | Item<TrackTitleTime> | Item<TrackTitleBPM> | Item<TrackTitleLabel> | Item<TrackTitleKey> | Item<TrackTitleBitRate> | Item<TrackTitleColor> | Item<TrackTitleComment> | Item<TrackTitleOriginalArtist> | Item<TrackTitleRemixer> | Item<TrackTitleDJPlayCount> | Item<MenuTrackTitleDateAdded>);
    16897: ((_args: Field[]) => null);
    17410: ((args: Field[]) => WaveformPreview);
    17922: ((args: Field[]) => BeatGrid);
    18178: ((args: Field[]) => CueAndLoop[]);
    18946: ((args: Field[]) => WaveformDetailed);
    19970: ((args: Field[]) => CueAndLoop[]);
    20226: ((args: Field[]) => WaveformHD);
}[ResponseType<T>]>
- Defined in src/remotedb/message/index.ts:186

Methods

`Static` fromStream

fromStream<T>(stream: PromiseReadable<any>, expect: T, span: Span): Promise<Message<T>>
Read a single mesasge via a readable stream
Type Parameters
- T extends Response
Parameters
- stream: PromiseReadable<any>
- expect: T
- span: Span
Returns Promise<Message<T>>
- Defined in src/remotedb/message/index.ts:69

Class Message<T>

Type Parameters

T extends MessageType = MessageType

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends MessageType = MessageType

Parameters

__namedParameters: Options<T>

Returns Message<T>

Properties

`Readonly` args

`Optional` transactionId

`Readonly` type

Accessors

buffer

Returns Buffer

data

Methods

`Static` fromStream

Type Parameters

T extends Response

Parameters

stream: PromiseReadable<any>

expect: T

span: Span

Returns Promise<Message<T>>

Settings

Member Visibility

Theme

Class Message<T>

Type Parameters

T extends MessageType = MessageType

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends MessageType = MessageType

Parameters

__namedParameters: Options<T>

Returns Message<T>

Properties

Readonly args

Optional transactionId

Readonly type

Accessors

buffer

Returns Buffer

data

Methods

Static fromStream

Type Parameters

T extends Response

Parameters

stream: PromiseReadable<any>

expect: T

span: Span

Returns Promise<Message<T>>

Settings

Member Visibility

Theme

`Readonly` args

`Optional` transactionId

`Readonly` type

`Static` fromStream