Skip to content

Commit dc55d6e

Browse files
author
hirsch88
committed
Add unavailable repsonse helper
1 parent f840697 commit dc55d6e

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

src/core/api/extendExpressResponse.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,15 @@ export const extendExpressResponse = (req: myExpress.Request, res: myExpress.Res
6464
return res.json(bodyFailed(message, error));
6565
};
6666

67+
/**
68+
* 503 - Service Unavailable
69+
* This is used when a service is unavailable
70+
*/
71+
res.unavailable = () => {
72+
res.status(503);
73+
return res.json(bodyFailed('Service unavailable'));
74+
};
75+
6776
next();
6877
};
6978

src/types/my-express.d.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,9 @@ declare namespace myExpress {
2727
created<T>(data: T, options?: ResponseOptions): void;
2828
found<T>(data: T, options?: ResponseOptions): void;
2929
updated<T>(data: T, options?: ResponseOptions): void;
30-
destroyed<T>(options?: ResponseOptions): void;
31-
failed<T>(status: number, message: string, error?: any): void;
30+
destroyed(options?: ResponseOptions): void;
31+
failed(status: number, message: string, error?: any): void;
32+
unavailable(): void;
3233
}
3334

3435
interface ResponseOptions {

0 commit comments

Comments
 (0)