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

rename server FormData module to Multipart #369

Merged
merged 1 commit into from
Dec 20, 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
7 changes: 7 additions & 0 deletions .changeset/funny-beans-peel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"@effect/platform-node": minor
"@effect/platform-bun": minor
"@effect/platform": minor
---

rename server FormData module to Multipart
26 changes: 13 additions & 13 deletions docs/platform-bun/HttpServer.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Added in v1.0.0
- [body](#body)
- [error](#error)
- [etag](#etag)
- [formData](#formdata)
- [headers](#headers)
- [middleware](#middleware)
- [multipart](#multipart)
- [request](#request)
- [response](#response)
- [router](#router)
Expand Down Expand Up @@ -82,44 +82,44 @@ Added in v1.0.0
- Docs: [Http/Etag](https://effect-ts.github.io/platform/platform-node/Http/Etag.ts.html)
- Module: `@effect/platform-node/Http/Etag`

## formData
## headers

**Signature**

```ts
export declare const formData: typeof formData
export declare const headers: typeof headers
```

Added in v1.0.0

- Docs: [Http/FormData](https://effect-ts.github.io/platform/platform-node/Http/FormData.ts.html)
- Module: `@effect/platform-node/Http/FormData`
- Docs: [Http/Headers](https://effect-ts.github.io/platform/platform/Http/Headers.ts.html)
- Module: `@effect/platform/Http/Headers`

## headers
## middleware

**Signature**

```ts
export declare const headers: typeof headers
export declare const middleware: typeof middleware
```

Added in v1.0.0

- Docs: [Http/Headers](https://effect-ts.github.io/platform/platform/Http/Headers.ts.html)
- Module: `@effect/platform/Http/Headers`
- Docs: [Http/Middleware](https://effect-ts.github.io/platform/platform/Http/Middleware.ts.html)
- Module: `@effect/platform/Http/Middleware`

## middleware
## multipart

**Signature**

```ts
export declare const middleware: typeof middleware
export declare const multipart: typeof multipart
```

Added in v1.0.0

- Docs: [Http/Middleware](https://effect-ts.github.io/platform/platform/Http/Middleware.ts.html)
- Module: `@effect/platform/Http/Middleware`
- Docs: [Http/Multipart](https://effect-ts.github.io/platform/platform-node/Http/Multipart.ts.html)
- Module: `@effect/platform-node/Http/Multipart`

## request

Expand Down
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
---
title: Http/FormData.ts
title: Http/Multipart.ts
nav_order: 7
parent: "@effect/platform-node"
---

## FormData overview
## Multipart overview

Added in v1.0.0

Also includes exports from [`@effect/platform/Http/FormData`](https://effect-ts.github.io/platform/platform/Http/FormData.ts.html).
Also includes exports from [`@effect/platform/Http/Multipart`](https://effect-ts.github.io/platform/platform/Http/Multipart.ts.html).

---

<h2 class="text-delta">Table of contents</h2>

- [constructors](#constructors)
- [formData](#formdata)
- [persisted](#persisted)
- [stream](#stream)
- [conversions](#conversions)
- [fileToReadable](#filetoreadable)
- [exports](#exports)
- [From "@effect/platform/Http/FormData"](#from-effectplatformhttpformdata)
- [From "@effect/platform/Http/Multipart"](#from-effectplatformhttpmultipart)

---

# constructors

## formData
## persisted

**Signature**

```ts
export declare const formData: (
export declare const persisted: (
source: Readable,
headers: IncomingHttpHeaders
) => Effect.Effect<FileSystem.FileSystem | Path.Path | Scope.Scope, FormData.FormDataError, FormData.PersistedFormData>
) => Effect.Effect<FileSystem.FileSystem | Path.Path | Scope.Scope, Multipart.MultipartError, Multipart.Persisted>
```

Added in v1.0.0
Expand All @@ -47,7 +47,7 @@ Added in v1.0.0
export declare const stream: (
source: Readable,
headers: IncomingHttpHeaders
) => Stream.Stream<never, FormData.FormDataError, FormData.Part>
) => Stream.Stream<never, Multipart.MultipartError, Multipart.Part>
```

Added in v1.0.0
Expand All @@ -59,21 +59,21 @@ Added in v1.0.0
**Signature**

```ts
export declare const fileToReadable: (file: FormData.File) => Readable
export declare const fileToReadable: (file: Multipart.File) => Readable
```

Added in v1.0.0

# exports

## From "@effect/platform/Http/FormData"
## From "@effect/platform/Http/Multipart"

Re-exports all named exports from the "@effect/platform/Http/FormData" module.
Re-exports all named exports from the "@effect/platform/Http/Multipart" module.

**Signature**

```ts
export * from "@effect/platform/Http/FormData"
export * from "@effect/platform/Http/Multipart"
```

Added in v1.0.0
26 changes: 13 additions & 13 deletions docs/platform-node/HttpServer.ts.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,9 @@ Added in v1.0.0
- [body](#body)
- [error](#error)
- [etag](#etag)
- [formData](#formdata)
- [headers](#headers)
- [middleware](#middleware)
- [multipart](#multipart)
- [request](#request)
- [response](#response)
- [router](#router)
Expand Down Expand Up @@ -82,44 +82,44 @@ Added in v1.0.0
- Docs: [Http/Etag](https://effect-ts.github.io/platform/platform-node/Http/Etag.ts.html)
- Module: `@effect/platform-node/Http/Etag`

## formData
## headers

**Signature**

```ts
export declare const formData: typeof formData
export declare const headers: typeof headers
```

Added in v1.0.0

- Docs: [Http/FormData](https://effect-ts.github.io/platform/platform-node/Http/FormData.ts.html)
- Module: `@effect/platform-node/Http/FormData`
- Docs: [Http/Headers](https://effect-ts.github.io/platform/platform/Http/Headers.ts.html)
- Module: `@effect/platform/Http/Headers`

## headers
## middleware

**Signature**

```ts
export declare const headers: typeof headers
export declare const middleware: typeof middleware
```

Added in v1.0.0

- Docs: [Http/Headers](https://effect-ts.github.io/platform/platform/Http/Headers.ts.html)
- Module: `@effect/platform/Http/Headers`
- Docs: [Http/Middleware](https://effect-ts.github.io/platform/platform/Http/Middleware.ts.html)
- Module: `@effect/platform/Http/Middleware`

## middleware
## multipart

**Signature**

```ts
export declare const middleware: typeof middleware
export declare const multipart: typeof multipart
```

Added in v1.0.0

- Docs: [Http/Middleware](https://effect-ts.github.io/platform/platform/Http/Middleware.ts.html)
- Module: `@effect/platform/Http/Middleware`
- Docs: [Http/Multipart](https://effect-ts.github.io/platform/platform-node/Http/Multipart.ts.html)
- Module: `@effect/platform-node/Http/Multipart`

## request

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/Http/Headers.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Http/Headers.ts
nav_order: 14
nav_order: 13
parent: "@effect/platform"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/Http/IncomingMessage.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Http/IncomingMessage.ts
nav_order: 15
nav_order: 14
parent: "@effect/platform"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/Http/Method.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Http/Method.ts
nav_order: 16
nav_order: 15
parent: "@effect/platform"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/platform/Http/Middleware.ts.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Http/Middleware.ts
nav_order: 17
nav_order: 16
parent: "@effect/platform"
---

Expand Down
Loading