Skip to content

Schema: Add standardSchemaV1 API to Generate a Standard Schema #4359

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
gcanti merged 3 commits into from
Feb 5, 2025
Merged

Schema: Add standardSchemaV1 API to Generate a Standard Schema #4359

gcanti merged 3 commits into from
Feb 5, 2025

Conversation

@gcanti
Copy link
Contributor

@gcanti gcanti commented Jan 28, 2025 •
edited
Loading

Returns a "Standard Schema" object conforming to the Standard Schema v1 specification.

This function creates a schema whose validate method attempts to decode and validate the provided input synchronously. If the underlying Schema includes any asynchronous components (e.g., asynchronous message resolutions
or checks), then validation will necessarily return a Promise instead.

Any detected defects will be reported via a single issue containing no path.

Example

import { Schema } from "effect"

const schema = Schema.Struct({
  name: Schema.String
})

//      ┌─── StandardSchemaV1<{ readonly name: string; }>
//      ▼
const standardSchema = Schema.standardSchemaV1(schema)

@gcanti gcanti added the schema label Jan 28, 2025
@changeset-bot
Copy link

changeset-bot bot commented Jan 28, 2025 •
edited
Loading

🦋 Changeset detected

Latest commit: e69b12d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 35 packages
Name Type
effect Minor
@effect/cli Major
@effect/cluster-browser Major
@effect/cluster-node Major
@effect/cluster-workflow Major
@effect/cluster Major
@effect/experimental Major
@effect/opentelemetry Major
@effect/platform-browser Major
@effect/platform-bun Major
@effect/platform-node-shared Major
@effect/platform-node Major
@effect/platform Major
@effect/printer-ansi Major
@effect/printer Major
@effect/rpc-http Major
@effect/rpc Major
@effect/sql-clickhouse Major
@effect/sql-d1 Major
@effect/sql-drizzle Major
@effect/sql-kysely Major
@effect/sql-libsql Major
@effect/sql-mssql Major
@effect/sql-mysql2 Major
@effect/sql-pg Major
@effect/sql-sqlite-bun Major
@effect/sql-sqlite-do Major
@effect/sql-sqlite-node Major
@effect/sql-sqlite-react-native Major
@effect/sql-sqlite-wasm Major
@effect/sql Major
@effect/typeclass Major
@effect/vitest Major
@effect/ai Major
@effect/ai-openai Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@gcanti gcanti changed the title Schema: Add standard API to Generate a Standard Schema Schema: Add standardSchemaV1 API to Generate a Standard Schema Jan 29, 2025
@gcanti gcanti mentioned this pull request Jan 29, 2025
Closed
@effect-bot effect-bot force-pushed the next-minor branch 3 times, most recently from c7af09f to fb6f9d8 Compare February 1, 2025 05:11
@tim-smart tim-smart force-pushed the fix-4355-standard-schema branch 2 times, most recently from 84dea62 to 52160a6 Compare February 1, 2025 06:53
@effect-bot effect-bot force-pushed the next-minor branch 19 times, most recently from 8657cfb to b563ce3 Compare February 5, 2025 14:55
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
d8c93f3 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
ac4cc70 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
138e585 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
6c256aa 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
d2f3ba5 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
8f191aa 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 6, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
3bd8b6a 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 7, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
097e10b 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 7, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
79ee777 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 9, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
7f7b50a 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 10, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
7317d44 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
e442632 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
46add9b 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
53ddd0f 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
e1ece5c 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
8755936 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
6d9f843 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
be3f528 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
ba37ffd 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 11, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
3903675 
Co-authored-by: Tim <[email protected]>
@tim-smart tim-smart mentioned this pull request Feb 12, 2025
Merged
effect-bot pushed a commit that referenced this pull request Feb 12, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
c663773 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 12, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
cf38db8 
Co-authored-by: Tim <[email protected]>
effect-bot pushed a commit that referenced this pull request Feb 13, 2025
@gcanti @tim-smart @effect-bot
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
579c8e0 
Co-authored-by: Tim <[email protected]>
tim-smart added a commit that referenced this pull request Feb 14, 2025
@gcanti @tim-smart
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
9a95831 
Co-authored-by: Tim <[email protected]>
tim-smart added a commit that referenced this pull request Feb 14, 2025
@gcanti @tim-smart
Schema: Add standardSchemaV1 API to Generate a Standard Schema (#4359)
9760fdc 
Co-authored-by: Tim <[email protected]>
@gcanti gcanti mentioned this pull request Feb 14, 2025
Closed
@ImBIOS ImBIOS mentioned this pull request Jul 28, 2025
Closed
WestBearMethod added a commit to WestBearMethod/project-kaguya that referenced this pull request Dec 10, 2025
@WestBearMethod
(#3) feat: データベースへ YouTube の概要欄を保存する処理を実装した。
a543c20 
Elysia では Effect.schema を用いて HTTP リクエスト、HTTP レスポンスを型安全にすることができる。
これによってテストで受け取る値も型安全に処理することができるようになる。

以下の URL でどのようにして Effect と Elysia を組み合わせるかを学んだ。
Effect-TS/effect#4359

また、Effect.runPromiseExit を用いることで Effect の成功型、失敗型をパターンマッチさせていることに注目したい。
@WestBearMethod WestBearMethod mentioned this pull request Dec 10, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mikearnaldi mikearnaldi Awaiting requested review from mikearnaldi mikearnaldi is a code owner

Assignees

No one assigned

Labels

schema

Projects

PR Backlog
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@gcanti @tim-smart