aboutsummaryrefslogtreecommitdiffhomepage
path: root/packages/models/src/http/http-methods.ts
blob: ec3c855d87f30cdf0ee7d643eba3fbe4fa3c8ef7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
/** HTTP request method to indicate the desired action to be performed for a given resource. */
export const HttpMethod = {
  /** The CONNECT method establishes a tunnel to the server identified by the target resource. */
  CONNECT: 'CONNECT',
  /** The DELETE method deletes the specified resource. */
  DELETE: 'DELETE',
  /** The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. */
  GET: 'GET',
  /** The HEAD method asks for a response identical to that of a GET request, but without the response body. */
  HEAD: 'HEAD',
  /** The OPTIONS method is used to describe the communication options for the target resource. */
  OPTIONS: 'OPTIONS',
  /** The PATCH method is used to apply partial modifications to a resource. */
  PATCH: 'PATCH',
  /** The POST method is used to submit an entity to the specified resource */
  POST: 'POST',
  /** The PUT method replaces all current representations of the target resource with the request payload. */
  PUT: 'PUT',
  /** The TRACE method performs a message loop-back test along the path to the target resource. */
  TRACE: 'TRACE'
} as const

export type HttpMethodType = typeof HttpMethod[keyof typeof HttpMethod]