MCPcopy Create free account
hub / github.com/Effect-TS/effect / make

Function make

packages/effect/src/unstable/httpapi/HttpApiEndpoint.ts:979–1095  ·  view source on GitHub ↗
(method: Method)

Source from the content-addressed store, hash-verified

977 * @since 4.0.0
978 */
979export const make = <Method extends HttpMethod>(method: Method): {
980 <
981 const Identifier extends string,
982 const Path extends HttpRouter.PathInput,
983 Params extends Schema.Top | Schema.Struct.Fields = never,
984 Query extends Schema.Top | Schema.Struct.Fields = never,
985 Payload extends PayloadConstraintCodecs<Method> = never,
986 Headers extends Schema.Top | Schema.Struct.Fields = never,
987 const Success extends SuccessConstraint = HttpApiSchema.NoContent,
988 const Error extends Schema.Top | ReadonlyArray<Schema.Top> = never
989 >(
990 identifier: Identifier,
991 path: Path,
992 options?: {
993 readonly disableCodecs?: false | undefined
994 readonly params?: Params | undefined
995 readonly query?: Query | undefined
996 readonly headers?: Headers | undefined
997 readonly payload?: Payload | undefined
998 readonly success?: Success | undefined
999 readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined
1000 }
1001 ): HttpApiEndpoint<
1002 Identifier,
1003 Method,
1004 Path,
1005 ToStringTreeCodec<Params>,
1006 ToStringTreeCodec<Query>,
1007 Method extends HttpMethod.WithBody ? ToJsonCodec<ToSchema<Payload>>
1008 : ToStringTreeCodec<ToSchema<Payload>>,
1009 ToStringTreeCodec<Headers>,
1010 ToSuccessCodec<Success>,
1011 ToJsonCodec<Error extends ReadonlyArray<Schema.Constraint> ? Error[number] : Error>
1012 >
1013 <
1014 const Identifier extends string,
1015 const Path extends HttpRouter.PathInput,
1016 Params extends ParamsConstraint = never,
1017 Query extends QueryConstraint = never,
1018 Payload extends PayloadConstraint<Method> = never,
1019 Headers extends HeadersConstraint = never,
1020 const Success extends SuccessConstraint = HttpApiSchema.NoContent,
1021 const Error extends ErrorConstraint = never
1022 >(
1023 identifier: Identifier,
1024 path: Path,
1025 options?: {
1026 readonly disableCodecs: true
1027 readonly params?: Params | undefined
1028 readonly query?: Query | undefined
1029 readonly headers?: Headers | undefined
1030 readonly payload?: Payload | undefined
1031 readonly success?: Success | undefined
1032 readonly error?: (Error & ErrorNoStream<Types.NoInfer<Error>>) | undefined
1033 }
1034 ): HttpApiEndpoint<
1035 Identifier,
1036 Method,

Callers 1

HttpApiEndpoint.tsFile · 0.70

Calls 5

ensureStructFunction · 0.85
getPayloadFunction · 0.85
getSuccessResponseFunction · 0.85
getErrorResponseFunction · 0.85
makeProtoFunction · 0.70

Tested by

no test coverage detected