HttpApiSchema
Annotations
AnnotationEmptyDecodeable
Added in v1.0.0
Source
Signature
declare const AnnotationEmptyDecodeable: unique symbol;AnnotationEncoding
Added in v1.0.0
Source
Signature
declare const AnnotationEncoding: unique symbol;AnnotationMultipart
Added in v1.0.0
Source
Signature
declare const AnnotationMultipart: unique symbol;AnnotationMultipartStream
Added in v1.0.0
Source
Signature
declare const AnnotationMultipartStream: unique symbol;AnnotationParam
Added in v1.0.0
Source
Signature
declare const AnnotationParam: unique symbol;annotations
Added in v1.0.0
Source
Signature
declare function annotations<A>(annotations: any): Schema<A>;AnnotationStatus
Added in v1.0.0
Source
Signature
declare const AnnotationStatus: unique symbol;extractAnnotations
Added in v1.0.0
Source
Signature
declare function extractAnnotations(ast: Annotations): Annotations;getEmptyDecodeable
Added in v1.0.0
Source
Signature
declare function getEmptyDecodeable(ast: AST): boolean;getEncoding
Added in v1.0.0
Source
Signature
declare function getEncoding(ast: AST, fallback: Encoding): Encoding;getMultipart
Added in v1.0.0
Source
Signature
declare function getMultipart(ast: AST): Options | undefined;getMultipartStream
Added in v1.0.0
Source
Signature
declare function getMultipartStream(ast: AST): Options | undefined;Signature
declare function getParam(ast: any): string | undefined;Signature
declare function getStatus(ast: AST, defaultStatus: number): number;Empty Errors
EmptyError
Added in v1.0.0
Source
Signature
declare const EmptyError: <Self>() => <Tag extends string>(options: {
readonly status: number;
readonly tag: Tag;
}) => EmptyErrorClass<Self, Tag>;EmptyError interface
Added in v1.0.0
Source
Signature
interface EmptyError<Self, Tag> extends Effect<never, Self> {
readonly _tag: Tag;
[ignoreSymbol]?: EmptyErrorUnifyIgnore;
[typeSymbol]?: unknown;
[unifySymbol]?: EmptyErrorUnify<EmptyError<Self, Tag>>;
}EmptyErrorClass interface
Added in v1.0.0
Source
Signature
interface EmptyErrorClass<Self, Tag> extends Schema<Self, void> {
constructor(_: void);
}Empty Response
Signature
declare const Accepted: Accepted;Signature
interface Accepted extends Void$ {
readonly _: typeof _;
}Signature
declare const asEmpty: {
<S extends Any>(options: {
readonly decode: LazyArg<Type<S>>;
readonly status: number;
}): (self: S) => asEmpty<S>;
<S extends Any>(
self: S,
options: {
readonly decode: LazyArg<Type<S>>;
readonly status: number;
},
): asEmpty<S>;
};Signature
interface asEmpty<S extends Schema.Schema.Any> extends transform<Void, S> {}Signature
declare const Created: Created;Signature
interface Created extends Void$ {
readonly _: typeof _;
}Signature
declare function Empty(status: number): Void;Signature
declare const NoContent: NoContent;Signature
interface NoContent extends Void$ {
readonly _: typeof _;
}Encoding
Signature
interface Encoding {
readonly contentType: string;
readonly kind: "Json" | "UrlParams" | "Uint8Array" | "Text";
}Signature
declare function Text(options?: { readonly contentType?: string }): String;Uint8Array
Added in v1.0.0
Source
Signature
declare function Uint8Array(options?: { readonly contentType?: string }): any;withEncoding
Added in v1.0.0
Source
Signature
declare const withEncoding: {
<A extends Any, Kind extends "Json" | "UrlParams" | "Uint8Array" | "Text">(
options: {
readonly contentType?: string;
readonly kind: Kind;
} & Validate<A, Kind>,
): (self: A) => A;
<A extends Any, Kind extends "Json" | "UrlParams" | "Uint8Array" | "Text">(
self: A,
options: {
readonly contentType?: string;
readonly kind: Kind;
} & Validate<A, Kind>,
): A;
};Models
EmptyErrorUnify interface
Added in v1.0.0
Source
Signature
interface EmptyErrorUnify<
A extends {
[typeSymbol]?: any;
},
> extends EffectUnify<A> {
EmptyError?: () => A[typeof typeSymbol] extends EmptyError<Self, _Tag> | _ ? Self : never;
}EmptyErrorUnifyIgnore interface
Added in v1.0.0
Source
Signature
interface EmptyErrorUnifyIgnore extends EffectUnifyIgnore {
Effect?: true;
}Multipart
Signature
declare const Multipart: <S extends Any>(self: S, options?: {
readonly fieldMimeTypes?: readonly Array<string>;
readonly maxFieldSize?: SizeInput;
readonly maxFileSize?: Option<SizeInput>;
readonly maxParts?: Option<number>;
readonly maxTotalSize?: Option<SizeInput>;
}) => Multipart<S>Signature
interface Multipart<S extends Schema.Schema.Any> extends Schema<
Schema.Schema.Type<S> & Brand<MultipartTypeId>,
Schema.Schema.Encoded<S>,
Schema.Schema.Context<S>
> {}MultipartStream
Added in v1.0.0
Source
Signature
declare const MultipartStream: <S extends Any>(self: S, options?: {
readonly fieldMimeTypes?: readonly Array<string>;
readonly maxFieldSize?: SizeInput;
readonly maxFileSize?: Option<SizeInput>;
readonly maxParts?: Option<number>;
readonly maxTotalSize?: Option<SizeInput>;
}) => MultipartStream<S>MultipartStream interface
Added in v1.0.0
Source
Signature
interface MultipartStream<S extends Schema.Schema.Any> extends Schema<
Schema.Schema.Type<S> & Brand<MultipartStreamTypeId>,
Schema.Schema.Encoded<S>,
Schema.Schema.Context<S>
> {}MultipartStreamTypeId
Added in v1.0.0
Source
Signature
declare const MultipartStreamTypeId: unique symbol;MultipartStreamTypeId type
Added in v1.0.0
Source
Signature
type MultipartStreamTypeId = typeof MultipartStreamTypeId;MultipartTypeId
Added in v1.0.0
Source
Signature
declare const MultipartTypeId: unique symbol;MultipartTypeId type
Added in v1.0.0
Source
Signature
type MultipartTypeId = typeof MultipartTypeId;Other
deunionize
Added in v1.0.0
Source
Signature
declare function deunionize(schemas: Set<Any>, schema: Any): void;UnionUnify
Added in v1.0.0
Source
Signature
declare function UnionUnify<A extends All, B extends All>(self: A, that: B): any;Path Params
Signature
declare const param: {
<Name extends string>(name: Name): <S extends any>(schema: S) => Param<Name, S>;
<Name extends string, S extends any>(name: Name, schema: S): Param<Name, S>;
};Signature
interface Param<
Name extends string,
S extends Schema.Schema.Any | Schema.PropertySignature.Any,
> extends Schema<Schema.Schema.Type<S>, Schema.Schema.Encoded<S>, Schema.Schema.Context<S>> {
readonly [AnnotationParam]: {
readonly name: Name;
readonly schema: S;
};
}Reflection
getStatusError
Added in v1.0.0
Source
Signature
declare function getStatusError<A extends All>(self: A): number;getStatusErrorAST
Added in v1.0.0
Source
Signature
declare function getStatusErrorAST(ast: AST): number;getStatusSuccess
Added in v1.0.0
Source
Signature
declare function getStatusSuccess<A extends Any>(self: A): number;getStatusSuccessAST
Added in v1.0.0
Source
Signature
declare function getStatusSuccessAST(ast: AST): number;Signature
declare function isVoid(ast: AST): boolean;