Start JSDocs
This commit is contained in:
@@ -1,3 +1,11 @@
|
||||
/**
|
||||
* Enum of HTTP statuses.
|
||||
* @example
|
||||
* HTTPStatus.http200 // => 200
|
||||
*
|
||||
* @example
|
||||
* HTTPStatus.REQUEST_TIMEOUT // => 408
|
||||
*/
|
||||
export enum HTTPStatus {
|
||||
http100 = 100,
|
||||
http101 = 101,
|
||||
@@ -110,6 +118,9 @@ export enum HTTPStatus {
|
||||
NETWORK_AUTHENTICATION_REQUIRED = 511,
|
||||
}
|
||||
|
||||
/**
|
||||
* Maps HTTP status code to default status message.
|
||||
*/
|
||||
export const Message = {
|
||||
100: 'Continue',
|
||||
101: 'Switching Protocols',
|
||||
|
||||
@@ -1,3 +1,6 @@
|
||||
/**
|
||||
* Enum of unit statuses.
|
||||
*/
|
||||
enum Status {
|
||||
Stopped = 'stopped',
|
||||
Starting = 'starting',
|
||||
@@ -6,6 +9,11 @@ enum Status {
|
||||
Error = 'error',
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns true if the given value is a valid unit status.
|
||||
* @param something
|
||||
* @return boolean
|
||||
*/
|
||||
const isStatus = (something: any) => [
|
||||
Status.Stopped,
|
||||
Status.Starting,
|
||||
|
||||
Reference in New Issue
Block a user