Skip to content

Commit

Permalink
Cleanup http methods typings
Browse files Browse the repository at this point in the history
  • Loading branch information
kanongil authored and Marsup committed Apr 3, 2024
1 parent d492bbf commit 8fb8479
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 24 deletions.
6 changes: 0 additions & 6 deletions lib/types/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,4 @@ export namespace Utils {
interface Dictionary<T> {
[key: string]: T;
}

type HTTP_METHODS_PARTIAL_LOWERCASE = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options';

type HTTP_METHODS_PARTIAL = Uppercase<HTTP_METHODS_PARTIAL_LOWERCASE> | HTTP_METHODS_PARTIAL_LOWERCASE;

type HTTP_METHODS = 'HEAD' | 'head' | HTTP_METHODS_PARTIAL;
}
8 changes: 4 additions & 4 deletions lib/types/request.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { PluginsStates, ServerRealm } from './plugin';
import { ResponseValue, ResponseObject } from "./response";
import { RouteRules, RouteSettings } from './route';
import { Server, ServerAuthSchemeObjectApi } from './server';
import { HTTP_METHODS_PARTIAL, HTTP_METHODS_PARTIAL_LOWERCASE, PeekListener } from './utils';
import { HTTP_METHODS, PeekListener } from './utils';

/**
* User extensible types user credentials.
Expand Down Expand Up @@ -192,7 +192,7 @@ export interface RequestInfo {
*/
export interface RequestRoute<Refs extends ReqRef = ReqRefDefaults> {
/** the route HTTP method. */
method: HTTP_METHODS_PARTIAL;
method: Exclude<Lowercase<HTTP_METHODS>, 'head'> | '*';

/** the route path. */
path: string;
Expand Down Expand Up @@ -374,7 +374,7 @@ export interface Request<Refs extends ReqRef = ReqRefDefaults> extends Podium {
/**
* The request method in lower case (e.g. 'get', 'post').
*/
readonly method: HTTP_METHODS_PARTIAL_LOWERCASE;
readonly method: Lowercase<HTTP_METHODS>;

/**
* The parsed content-type header. Only available when payload parsing enabled and no payload error occurred.
Expand Down Expand Up @@ -506,7 +506,7 @@ export interface Request<Refs extends ReqRef = ReqRefDefaults> extends Podium {
* Can only be called from an 'onRequest' extension method.
* [See docs](https://hapijs.com/api/17.0.1#-requestsetmethodmethod)
*/
setMethod(method: HTTP_METHODS_PARTIAL): void;
setMethod(method: HTTP_METHODS | Lowercase<HTTP_METHODS>): void;

/**
* Changes the request URI before the router begins processing the request where:
Expand Down
6 changes: 4 additions & 2 deletions lib/types/route.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { ObjectSchema, ValidationOptions, SchemaMap, Schema } from 'joi';
import { PluginSpecificConfiguration} from './plugin';
import { MergeType, ReqRef, ReqRefDefaults, MergeRefs, AuthMode } from './request';
import { ContentDecoders, ContentEncoders, RouteRequestExtType, RouteExtObject, Server } from './server';
import { Lifecycle, Json, HTTP_METHODS_PARTIAL } from './utils';
import { Lifecycle, Json, HTTP_METHODS } from './utils';

/**
* Overrides for `InternalRouteOptionType`. Extend this to have
Expand Down Expand Up @@ -924,6 +924,8 @@ export interface RulesProcessor<Refs extends ReqRef = ReqRefDefaults> {
(rules: MergeRefs<Refs>['Rules'] | null, info: RulesInfo): Partial<RouteOptions<Refs>> | null;
}

type RouteDefMethods = Exclude<HTTP_METHODS | Lowercase<HTTP_METHODS>, 'HEAD' | 'head'>;

/**
* A route configuration object or an array of configuration objects where each object contains:
* * path - (required) the absolute path used to match incoming requests (must begin with '/'). Incoming requests are compared to the configured paths based on the server's router configuration. The
Expand Down Expand Up @@ -952,7 +954,7 @@ export interface ServerRoute<Refs extends ReqRef = ReqRefDefaults> {
* (only when an exact match was not found, and any match with a specific method will be given a higher priority over a wildcard match). Can be assigned an array of methods which has the same
* result as adding the same route with different methods manually.
*/
method: HTTP_METHODS_PARTIAL | HTTP_METHODS_PARTIAL[] | string | string[];
method: RouteDefMethods | RouteDefMethods[] | '*';

/**
* (optional) a domain string or an array of domain strings for limiting the route to only requests with a matching host header field. Matching is done against the hostname part of the header
Expand Down
19 changes: 7 additions & 12 deletions lib/types/utils.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,13 @@ import {
Request} from './request';
import { ResponseToolkit, Auth } from './response';

export type HTTP_METHODS_PARTIAL_LOWERCASE = 'get' | 'post' | 'put' | 'patch' | 'delete' | 'options';

export type HTTP_METHODS_PARTIAL =
'GET'
| 'POST'
| 'PUT'
| 'PATCH'
| 'DELETE'
| 'OPTIONS'
| HTTP_METHODS_PARTIAL_LOWERCASE;

export type HTTP_METHODS = 'HEAD' | 'head' | HTTP_METHODS_PARTIAL;
/**
* All http parser [supported HTTP methods](https://nodejs.org/api/http.html#httpmethods).
*/
export type HTTP_METHODS = 'ACL' | 'BIND' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'DELETE' | 'GET' | 'HEAD' | 'LINK' | 'LOCK' |
'M-SEARCH' | 'MERGE' | 'MKACTIVITY' | 'MKCALENDAR' | 'MKCOL' | 'MOVE' | 'NOTIFY' | 'OPTIONS' | 'PATCH' | 'POST' |
'PROPFIND' | 'PROPPATCH' | 'PURGE' | 'PUT' | 'REBIND' | 'REPORT' | 'SEARCH' | 'SOURCE' | 'SUBSCRIBE' | 'TRACE' |
'UNBIND' | 'UNLINK' | 'UNLOCK' | 'UNSUBSCRIBE';

export type PeekListener = (chunk: string, encoding: string) => void;

Expand Down

0 comments on commit 8fb8479

Please sign in to comment.