Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

update docs #15

Merged
merged 1 commit into from
Dec 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 70 additions & 0 deletions docs/modules/Socket.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,22 @@ 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)
- [Socket](#socket)
- [type ids](#type-ids)
- [SocketTypeId](#sockettypeid)
- [SocketTypeId (type alias)](#sockettypeid-type-alias)
- [utils](#utils)
- [defaultCloseCodeIsError](#defaultclosecodeiserror)

---

Expand Down Expand Up @@ -62,6 +69,32 @@ export declare const makeChannel: <IE = never>() => 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<Scope.Scope, SocketError, Socket>
```

Added in v1.0.0

## makeWebSocketChannel

**Signature**

```ts
export declare const makeWebSocketChannel: <IE = never>(
url: string,
options?: { readonly closeCodeIsError?: ((code: number) => boolean) | undefined } | undefined
) => Channel.Channel<never, IE, Chunk.Chunk<Uint8Array>, unknown, SocketError | IE, Chunk.Chunk<Uint8Array>, void>
```

Added in v1.0.0

# errors

## SocketError (class)
Expand All @@ -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<never, SocketError, Socket>
```

Added in v1.0.0

# models

## Socket (interface)
Expand Down Expand Up @@ -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
3 changes: 3 additions & 0 deletions src/Socket.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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}`
}
Expand Down
Loading