Skip to main content Link Search Menu Expand Document (external link)

EventLogRemote overview

Added in v1.0.0


Table of contents


change

RemoteAdditions (class)

Signature

export declare class RemoteAdditions

Added in v1.0.0

construtors

fromSocket

Signature

export declare const fromSocket: (options?: {
  readonly disablePing?: boolean
}) => Effect.Effect<void, never, Scope.Scope | EventLog | EventLogEncryption | Socket.Socket>

Added in v1.0.0

fromWebSocket

Signature

export declare const fromWebSocket: (
  url: string,
  options?: { readonly disablePing?: boolean }
) => Effect.Effect<void, never, Scope.Scope | EventLogEncryption | EventLog | Socket.WebSocketConstructor>

Added in v1.0.0

layers

layerWebSocket

Signature

export declare const layerWebSocket: (
  url: string,
  options?: { readonly disablePing?: boolean }
) => Layer.Layer<never, never, Socket.WebSocketConstructor | EventLog | EventLogEncryption>

Added in v1.0.0

layerWebSocketBrowser

Signature

export declare const layerWebSocketBrowser: (
  url: string,
  options?: { readonly disablePing?: boolean }
) => Layer.Layer<never, never, EventLog>

Added in v1.0.0

models

EventLogRemote (interface)

Signature

export interface EventLogRemote {
  readonly id: RemoteId
  readonly changes: (
    identity: typeof Identity.Service,
    startSequence: number
  ) => Effect.Effect<Mailbox.ReadonlyMailbox<RemoteEntry>, never, Scope.Scope>
  readonly write: (identity: typeof Identity.Service, entries: ReadonlyArray<Entry>) => Effect.Effect<void>
}

Added in v1.0.0

protocol

Ack (class)

Signature

export declare class Ack

Added in v1.0.0

Changes (class)

Signature

export declare class Changes

Added in v1.0.0

ChunkedMessage (class)

Signature

export declare class ChunkedMessage

Added in v1.0.0

split (static method)

Signature

static split(id: number, data: Uint8Array): ReadonlyArray<ChunkedMessage>

Added in v1.0.0

join (static method)

Signature

static join(
    map: Map<number, {
      readonly parts: Array<Uint8Array>
      count: number
      bytes: number
    }>,
    part: ChunkedMessage
  ): Uint8Array | undefined

Added in v1.0.0

Hello (class)

Signature

export declare class Hello

Added in v1.0.0

Ping (class)

Signature

export declare class Ping

Added in v1.0.0

Pong (class)

Signature

export declare class Pong

Added in v1.0.0

ProtocolRequest

Signature

export declare const ProtocolRequest: any

Added in v1.0.0

ProtocolRequestMsgPack

Signature

export declare const ProtocolRequestMsgPack: MsgPack.schema<any>

Added in v1.0.0

ProtocolResponse

Signature

export declare const ProtocolResponse: any

Added in v1.0.0

ProtocolResponseMsgPack

Signature

export declare const ProtocolResponseMsgPack: MsgPack.schema<any>

Added in v1.0.0

RequestChanges (class)

Signature

export declare class RequestChanges

Added in v1.0.0

StopChanges (class)

Signature

export declare class StopChanges

Added in v1.0.0

WriteEntries (class)

Signature

export declare class WriteEntries

Added in v1.0.0

decodeRequest

Signature

export declare const decodeRequest: any

Added in v1.0.0

decodeResponse

Signature

export declare const decodeResponse: any

Added in v1.0.0

encodeRequest

Signature

export declare const encodeRequest: any

Added in v1.0.0

encodeResponse

Signature

export declare const encodeResponse: any

Added in v1.0.0