@effect/platform 0.66.2 → 0.67.0

package/src/HttpServerResponse.ts

@@ -102,10 +102,18 @@ export const text: (body: string, options?: Options.WithContentType | undefined)
  * @category constructors
  */
 export const html: {
+  /**
+   * @since 1.0.0
+   * @category constructors
+   */
   <A extends ReadonlyArray<Template.Interpolated>>(
     strings: TemplateStringsArray,
     ...args: A
   ): Effect.Effect<HttpServerResponse, Template.Interpolated.Error<A[number]>, Template.Interpolated.Context<A[number]>>
+  /**
+   * @since 1.0.0
+   * @category constructors
+   */
   (html: string): HttpServerResponse
 } = internal.html
 
@@ -196,7 +204,15 @@ export const fileWeb: (
  * @category combinators
  */
 export const setHeader: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: string): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, key: string, value: string): HttpServerResponse
 } = internal.setHeader
 
@@ -205,7 +221,15 @@ export const setHeader: {
  * @category combinators
  */
 export const setHeaders: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: Headers.Input): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, input: Headers.Input): HttpServerResponse
 } = internal.setHeaders
 
@@ -214,7 +238,15 @@ export const setHeaders: {
  * @category combinators
  */
 export const removeCookie: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (name: string): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, name: string): HttpServerResponse
 } = internal.removeCookie
 
@@ -223,7 +255,15 @@ export const removeCookie: {
  * @category combinators
  */
 export const replaceCookies: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (cookies: Cookies): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, cookies: Cookies): HttpServerResponse
 } = internal.replaceCookies
 
@@ -232,16 +272,20 @@ export const replaceCookies: {
  * @category combinators
  */
 export const setCookie: {
-  (
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): (
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (name: string, value: string, options?: Cookie["options"]): (
     self: HttpServerResponse
   ) => Effect.Effect<
     HttpServerResponse,
     CookiesError
   >
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: HttpServerResponse,
     name: string,
@@ -258,11 +302,15 @@ export const setCookie: {
  * @category combinators
  */
 export const unsafeSetCookie: {
-  (
-    name: string,
-    value: string,
-    options?: Cookie["options"]
-  ): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  (name: string, value: string, options?: Cookie["options"]): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: HttpServerResponse,
     name: string,
@@ -276,7 +324,15 @@ export const unsafeSetCookie: {
  * @category combinators
  */
 export const updateCookies: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (f: (cookies: Cookies) => Cookies): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, f: (cookies: Cookies) => Cookies): HttpServerResponse
 } = internal.updateCookies
 
@@ -285,6 +341,10 @@ export const updateCookies: {
  * @category combinators
  */
 export const setCookies: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     cookies: Iterable<
       readonly [
@@ -294,6 +354,10 @@ export const setCookies: {
       ]
     >
   ): (self: HttpServerResponse) => Effect.Effect<HttpServerResponse, CookiesError, never>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: HttpServerResponse,
     cookies: Iterable<
@@ -311,6 +375,10 @@ export const setCookies: {
  * @category combinators
  */
 export const unsafeSetCookies: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     cookies: Iterable<
       readonly [
@@ -320,6 +388,10 @@ export const unsafeSetCookies: {
       ]
     >
   ): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (
     self: HttpServerResponse,
     cookies: Iterable<
@@ -337,7 +409,15 @@ export const unsafeSetCookies: {
  * @category combinators
  */
 export const setBody: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (body: Body.HttpBody): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, body: Body.HttpBody): HttpServerResponse
 } = internal.setBody
 
@@ -346,7 +426,15 @@ export const setBody: {
  * @category combinators
  */
 export const setStatus: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (status: number, statusText?: string | undefined): (self: HttpServerResponse) => HttpServerResponse
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: HttpServerResponse, status: number, statusText?: string | undefined): HttpServerResponse
 } = internal.setStatus
 

package/src/KeyValueStore.ts

@@ -132,7 +132,15 @@ export const makeStringOnly: (
  * @category combinators
  */
 export const prefix: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (prefix: string): <S extends KeyValueStore.AnyStore>(self: S) => S
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   <S extends KeyValueStore.AnyStore>(self: S, prefix: string): S
 } = internal.prefix
 

package/src/Multipart.ts

@@ -163,7 +163,15 @@ export const maxParts: FiberRef.FiberRef<Option.Option<number>> = internal.maxPa
  * @category fiber refs
  */
 export const withMaxParts: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (count: Option.Option<number>): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, count: Option.Option<number>): Effect.Effect<A, E, R>
 } = internal.withMaxParts
 
@@ -178,7 +186,15 @@ export const maxFieldSize: FiberRef.FiberRef<FileSystem.Size> = internal.maxFiel
  * @category fiber refs
  */
 export const withMaxFieldSize: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (size: FileSystem.SizeInput): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, size: FileSystem.SizeInput): Effect.Effect<A, E, R>
 } = internal.withMaxFieldSize
 
@@ -193,7 +209,15 @@ export const maxFileSize: FiberRef.FiberRef<Option.Option<FileSystem.Size>> = in
  * @category fiber refs
  */
 export const withMaxFileSize: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (size: Option.Option<FileSystem.SizeInput>): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, size: Option.Option<FileSystem.SizeInput>): Effect.Effect<A, E, R>
 } = internal.withMaxFileSize
 
@@ -208,7 +232,15 @@ export const fieldMimeTypes: FiberRef.FiberRef<Chunk.Chunk<string>> = internal.f
  * @category fiber refs
  */
 export const withFieldMimeTypes: {
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   (mimeTypes: ReadonlyArray<string>): <A, E, R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<A, E, R>
+  /**
+   * @since 1.0.0
+   * @category fiber refs
+   */
   <A, E, R>(effect: Effect.Effect<A, E, R>, mimeTypes: ReadonlyArray<string>): Effect.Effect<A, E, R>
 } = internal.withFieldMimeTypes
 

package/src/OpenApi.ts

@@ -109,24 +109,37 @@ export interface Annotatable {
  * @category annotations
  */
 export const annotate: {
-  (annotations: {
-    readonly identifier?: string | undefined
-    readonly title?: string | undefined
-    readonly description?: string | undefined
-    readonly version?: string | undefined
-    readonly license?: OpenAPISpecLicense | undefined
-    readonly security?: HttpApiSecurity | undefined
-    readonly externalDocs?: OpenAPISpecExternalDocs | undefined
-  }): <A extends Annotatable>(self: A) => A
-  <A extends Annotatable>(self: A, annotations: {
-    readonly identifier?: string | undefined
-    readonly title?: string | undefined
-    readonly description?: string | undefined
-    readonly version?: string | undefined
-    readonly license?: OpenAPISpecLicense | undefined
-    readonly security?: HttpApiSecurity | undefined
-    readonly externalDocs?: OpenAPISpecExternalDocs | undefined
-  }): A
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
+  (
+    annotations: {
+      readonly identifier?: string | undefined
+      readonly title?: string | undefined
+      readonly description?: string | undefined
+      readonly version?: string | undefined
+      readonly license?: OpenAPISpecLicense | undefined
+      readonly security?: HttpApiSecurity | undefined
+      readonly externalDocs?: OpenAPISpecExternalDocs | undefined
+    }
+  ): <A extends Annotatable>(self: A) => A
+  /**
+   * @since 1.0.0
+   * @category annotations
+   */
+  <A extends Annotatable>(
+    self: A,
+    annotations: {
+      readonly identifier?: string | undefined
+      readonly title?: string | undefined
+      readonly description?: string | undefined
+      readonly version?: string | undefined
+      readonly license?: OpenAPISpecLicense | undefined
+      readonly security?: HttpApiSecurity | undefined
+      readonly externalDocs?: OpenAPISpecExternalDocs | undefined
+    }
+  ): A
 } = dual(2, <A extends Annotatable>(self: A, annotations_: {
   readonly identifier?: string | undefined
   readonly title?: string | undefined

package/src/PlatformLogger.ts

@@ -33,6 +33,29 @@ import * as internal from "./internal/platformLogger.js"
  * )
  */
 export const toFile: {
+  /**
+   * Create a Logger from another string Logger that writes to the specified file.
+   *
+   * @since 1.0.0
+   * @example
+   * import { PlatformLogger } from "@effect/platform"
+   * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
+   * import { Effect, Layer, Logger } from "effect"
+   *
+   * const fileLogger = Logger.logfmtLogger.pipe(
+   *   PlatformLogger.toFile("/tmp/log.txt")
+   * )
+   * const LoggerLive = Logger.replaceScoped(Logger.defaultLogger, fileLogger).pipe(
+   *   Layer.provide(NodeFileSystem.layer)
+   * )
+   *
+   * Effect.log("a").pipe(
+   *   Effect.zipRight(Effect.log("b")),
+   *   Effect.zipRight(Effect.log("c")),
+   *   Effect.provide(LoggerLive),
+   *   NodeRuntime.runMain
+   * )
+   */
   (
     path: string,
     options?:
@@ -45,6 +68,29 @@ export const toFile: {
   ): <Message>(
     self: Logger.Logger<Message, string>
   ) => Effect<Logger.Logger<Message, void>, PlatformError, Scope | FileSystem>
+  /**
+   * Create a Logger from another string Logger that writes to the specified file.
+   *
+   * @since 1.0.0
+   * @example
+   * import { PlatformLogger } from "@effect/platform"
+   * import { NodeFileSystem, NodeRuntime } from "@effect/platform-node"
+   * import { Effect, Layer, Logger } from "effect"
+   *
+   * const fileLogger = Logger.logfmtLogger.pipe(
+   *   PlatformLogger.toFile("/tmp/log.txt")
+   * )
+   * const LoggerLive = Logger.replaceScoped(Logger.defaultLogger, fileLogger).pipe(
+   *   Layer.provide(NodeFileSystem.layer)
+   * )
+   *
+   * Effect.log("a").pipe(
+   *   Effect.zipRight(Effect.log("b")),
+   *   Effect.zipRight(Effect.log("c")),
+   *   Effect.provide(LoggerLive),
+   *   NodeRuntime.runMain
+   * )
+   */
   <Message>(
     self: Logger.Logger<Message, string>,
     path: string,

package/src/Socket.ts

@@ -253,6 +253,10 @@ export const toChannel = <IE>(
  * @category combinators
  */
 export const toChannelString: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (encoding?: string | undefined): <IE>(self: Socket) => Channel.Channel<
     Chunk.Chunk<string>,
     Chunk.Chunk<Uint8Array | string | CloseEvent>,
@@ -261,10 +265,11 @@ export const toChannelString: {
     void,
     unknown
   >
-  <IE>(
-    self: Socket,
-    encoding?: string | undefined
-  ): Channel.Channel<
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
+  <IE>(self: Socket, encoding?: string | undefined): Channel.Channel<
     Chunk.Chunk<string>,
     Chunk.Chunk<Uint8Array | string | CloseEvent>,
     SocketError | IE,
@@ -407,13 +412,15 @@ export const fromWebSocket = <R>(
               let open = false
 
               function onMessage(event: MessageEvent) {
-                const result = handler(
-                  typeof event.data === "string"
-                    ? event.data
-                    : event.data instanceof Uint8Array
-                    ? event.data
-                    : new Uint8Array(event.data)
-                )
+                if (event.data instanceof Blob) {
+                  return Effect.promise(() =>
+                    event.data.arrayBuffer() as Promise<ArrayBuffer>
+                  ).pipe(
+                    Effect.andThen((buffer) => handler(new Uint8Array(buffer))),
+                    run
+                  )
+                }
+                const result = handler(event.data)
                 if (Effect.isEffect(result)) {
                   run(result)
                 }
@@ -476,8 +483,7 @@ export const fromWebSocket = <R>(
                       })
                     }) :
                     Effect.try({
-                      try: () =>
-                        ws.send(chunk),
+                      try: () => ws.send(chunk),
                       catch: (cause) => new SocketGenericError({ reason: "Write", cause })
                     })
                 ),

package/src/Transferable.ts

@@ -79,9 +79,15 @@ export const addAll = (tranferables: Iterable<globalThis.Transferable>): Effect.
  * @category schema
  */
 export const schema: {
-  <I>(
-    f: (_: I) => Iterable<globalThis.Transferable>
-  ): <A, R>(self: Schema.Schema<A, I, R>) => Schema.Schema<A, I, R>
+  /**
+   * @since 1.0.0
+   * @category schema
+   */
+  <I>(f: (_: I) => Iterable<globalThis.Transferable>): <A, R>(self: Schema.Schema<A, I, R>) => Schema.Schema<A, I, R>
+  /**
+   * @since 1.0.0
+   * @category schema
+   */
   <A, I, R>(
     self: Schema.Schema<A, I, R>,
     f: (_: I) => Iterable<globalThis.Transferable>

package/src/UrlParams.ts

@@ -71,7 +71,15 @@ export const empty: UrlParams = []
  * @category combinators
  */
 export const getAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: UrlParams) => ReadonlyArray<string>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, key: string): ReadonlyArray<string>
 } = dual(
   2,
@@ -89,7 +97,15 @@ export const getAll: {
  * @category combinators
  */
 export const getFirst: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: UrlParams) => Option.Option<string>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, key: string): Option.Option<string>
 } = dual(2, (self: UrlParams, key: string): Option.Option<string> =>
   Option.map(
@@ -102,7 +118,15 @@ export const getFirst: {
  * @category combinators
  */
 export const getLast: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: UrlParams) => Option.Option<string>
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, key: string): Option.Option<string>
 } = dual(2, (self: UrlParams, key: string): Option.Option<string> =>
   Option.map(
@@ -115,7 +139,15 @@ export const getLast: {
  * @category combinators
  */
 export const set: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: Coercible): (self: UrlParams) => UrlParams
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, key: string, value: Coercible): UrlParams
 } = dual(3, (self: UrlParams, key: string, value: Coercible): UrlParams =>
   Arr.append(
@@ -128,7 +160,15 @@ export const set: {
  * @category combinators
  */
 export const setAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: Input): (self: UrlParams) => UrlParams
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, input: Input): UrlParams
 } = dual(2, (self: UrlParams, input: Input): UrlParams => {
   const toSet = fromInput(input)
@@ -144,7 +184,15 @@ export const setAll: {
  * @category combinators
  */
 export const append: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string, value: Coercible): (self: UrlParams) => UrlParams
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, key: string, value: Coercible): UrlParams
 } = dual(3, (self: UrlParams, key: string, value: Coercible): UrlParams =>
   Arr.append(
@@ -157,7 +205,15 @@ export const append: {
  * @category combinators
  */
 export const appendAll: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (input: Input): (self: UrlParams) => UrlParams
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, input: Input): UrlParams
 } = dual(2, (self: UrlParams, input: Input): UrlParams => Arr.appendAll(self, fromInput(input)))
 
@@ -166,7 +222,15 @@ export const appendAll: {
  * @category combinators
  */
 export const remove: {
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (key: string): (self: UrlParams) => UrlParams
+  /**
+   * @since 1.0.0
+   * @category combinators
+   */
   (self: UrlParams, key: string): UrlParams
 } = dual(2, (self: UrlParams, key: string): UrlParams => Arr.filter(self, ([k]) => k !== key))
 

package/src/internal/httpBody.ts

@@ -33,6 +33,9 @@ abstract class BodyBase implements Body.HttpBody.Proto {
     this[TypeId] = TypeId
   }
   abstract toJSON(): unknown
+  [Inspectable.DenoInspectSymbol](): unknown {
+    return this.toJSON()
+  }
   [Inspectable.NodeInspectSymbol](): unknown {
     return this.toJSON()
   }