mirror of
https://github.com/yusing/godoxy.git
synced 2025-05-20 12:42:34 +02:00
127 lines
2.3 KiB
TypeScript
127 lines
2.3 KiB
TypeScript
/**
|
|
* @type "null"
|
|
*/
|
|
export interface Null {}
|
|
export type Nullable<T> = T | Null;
|
|
export type NullOrEmptyMap = {} | Null;
|
|
|
|
export const HTTP_METHODS = [
|
|
"GET",
|
|
"POST",
|
|
"PUT",
|
|
"PATCH",
|
|
"DELETE",
|
|
"CONNECT",
|
|
"HEAD",
|
|
"OPTIONS",
|
|
"TRACE",
|
|
] as const;
|
|
|
|
export type HTTPMethod = (typeof HTTP_METHODS)[number];
|
|
|
|
// "string & {}" Prevents skipping schema generation
|
|
|
|
/**
|
|
* HTTP Header
|
|
* @pattern ^[a-zA-Z0-9\-]+$
|
|
* @type string
|
|
*/
|
|
export type HTTPHeader = string & {};
|
|
|
|
/**
|
|
* HTTP Query
|
|
* @pattern ^[a-zA-Z0-9\-_]+$
|
|
* @type string
|
|
*/
|
|
export type HTTPQuery = string & {};
|
|
/**
|
|
* HTTP Cookie
|
|
* @pattern ^[a-zA-Z0-9\-_]+$
|
|
* @type string
|
|
*/
|
|
export type HTTPCookie = string & {};
|
|
|
|
export type StatusCode = number | `${number}`;
|
|
export type StatusCodeRange = number | `${number}` | `${number}-${number}`;
|
|
|
|
/**
|
|
* @items.pattern ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
|
|
*/
|
|
export type DomainNames = string[];
|
|
/**
|
|
* @items.pattern ^(\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$
|
|
*/
|
|
export type DomainOrWildcards = string[];
|
|
/**
|
|
* @format hostname
|
|
* @type string
|
|
*/
|
|
export type Hostname = string & {};
|
|
/**
|
|
* @format ipv4
|
|
* @type string
|
|
*/
|
|
export type IPv4 = string & {};
|
|
/**
|
|
* @format ipv6
|
|
* @type string
|
|
*/
|
|
export type IPv6 = string & {};
|
|
|
|
/* CIDR / IPv4 / IPv6 */
|
|
export type CIDR =
|
|
| `${number}.${number}.${number}.${number}`
|
|
| `${string}:${string}:${string}:${string}:${string}:${string}:${string}:${string}`
|
|
| `${number}.${number}.${number}.${number}/${number}`
|
|
| `::${number}`
|
|
| `${string}::/${number}`
|
|
| `${string}:${string}::/${number}`;
|
|
|
|
/**
|
|
* @type integer
|
|
* @minimum 0
|
|
* @maximum 65535
|
|
*/
|
|
export type Port = number | `${number}`;
|
|
|
|
/**
|
|
* @pattern ^\d+:\d+$
|
|
* @type string
|
|
*/
|
|
export type StreamPort = string & {};
|
|
|
|
/**
|
|
* @format email
|
|
* @type string
|
|
*/
|
|
export type Email = string & {};
|
|
|
|
/**
|
|
* @format uri
|
|
* @type string
|
|
*/
|
|
export type URL = string & {};
|
|
|
|
/**
|
|
* @format uri-reference
|
|
* @type string
|
|
*/
|
|
export type URI = string & {};
|
|
|
|
/**
|
|
* @pattern ^(?:([A-Z]+) )?(?:([a-zA-Z0-9.-]+)\\/)?(\\/[^\\s]*)$
|
|
* @type string
|
|
*/
|
|
export type PathPattern = string & {};
|
|
|
|
/**
|
|
* @pattern ^([0-9]+(ms|s|m|h))+$
|
|
* @type string
|
|
*/
|
|
export type Duration = string & {};
|
|
|
|
/**
|
|
* @format date-time
|
|
* @type string
|
|
*/
|
|
export type DateTime = string & {};
|