diff --git a/docs/modules/Socket.ts.md b/docs/modules/Socket.ts.md index 17f1e69..c92b85e 100644 --- a/docs/modules/Socket.ts.md +++ b/docs/modules/Socket.ts.md @@ -16,8 +16,13 @@ Added in v1.0.0 - [toChannel](#tochannel) - [constructors](#constructors) - [makeChannel](#makechannel) + - [makeWebSocket](#makewebsocket) + - [makeWebSocketChannel](#makewebsocketchannel) - [errors](#errors) - [SocketError (class)](#socketerror-class) + - [toString (method)](#tostring-method) +- [layers](#layers) + - [layerWebSocket](#layerwebsocket) - [models](#models) - [Socket (interface)](#socket-interface) - [tags](#tags) @@ -25,6 +30,8 @@ Added in v1.0.0 - [type ids](#type-ids) - [SocketTypeId](#sockettypeid) - [SocketTypeId (type alias)](#sockettypeid-type-alias) +- [utils](#utils) + - [defaultCloseCodeIsError](#defaultclosecodeiserror) --- @@ -62,6 +69,32 @@ export declare const makeChannel: () => Channel.Channel< Added in v1.0.0 +## makeWebSocket + +**Signature** + +```ts +export declare const makeWebSocket: ( + url: string, + options?: { readonly closeCodeIsError?: ((code: number) => boolean) | undefined } | undefined +) => Effect.Effect +``` + +Added in v1.0.0 + +## makeWebSocketChannel + +**Signature** + +```ts +export declare const makeWebSocketChannel: ( + url: string, + options?: { readonly closeCodeIsError?: ((code: number) => boolean) | undefined } | undefined +) => Channel.Channel, unknown, SocketError | IE, Chunk.Chunk, void> +``` + +Added in v1.0.0 + # errors ## SocketError (class) @@ -74,6 +107,31 @@ export declare class SocketError Added in v1.0.0 +### toString (method) + +**Signature** + +```ts +toString(): string +``` + +Added in v1.0.0 + +# layers + +## layerWebSocket + +**Signature** + +```ts +export declare const layerWebSocket: ( + url: string, + options?: { readonly closeCodeIsError?: ((code: number) => boolean) | undefined } | undefined +) => Layer.Layer +``` + +Added in v1.0.0 + # models ## Socket (interface) @@ -123,3 +181,15 @@ export type SocketTypeId = typeof SocketTypeId ``` Added in v1.0.0 + +# utils + +## defaultCloseCodeIsError + +**Signature** + +```ts +export declare const defaultCloseCodeIsError: (code: number) => boolean +``` + +Added in v1.0.0 diff --git a/src/Socket.ts b/src/Socket.ts index 4663fed..7e1a965 100644 --- a/src/Socket.ts +++ b/src/Socket.ts @@ -53,6 +53,9 @@ export class SocketError extends Data.TaggedError("SocketError")<{ readonly reason: "Write" | "Read" | "Open" | "Close" readonly error: unknown }> { + /** + * @since 1.0.0 + */ toString(): string { return `SocketError: ${this.reason} - ${this.error}` }