Skip to content

Commit 9fca3f2

Browse files
committed
fix: added new enveloped and paginated interfaces
1 parent c369a94 commit 9fca3f2

10 files changed

+49
-0
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
/// <reference types="node" />
2+
import { OutgoingHttpHeaders } from "http";
3+
export interface EnvelopedResponse<T> {
4+
readonly status: number;
5+
readonly body: T;
6+
readonly headers: OutgoingHttpHeaders;
7+
}

dist/interfaces/EnvelopedResponse.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/interfaces/EnvelopedResponse.js.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import Item from './Item';
2+
export interface PaginationMetadata {
3+
readonly hasAfter: boolean;
4+
readonly hasBefore: boolean;
5+
readonly after: string | null;
6+
readonly before: string | null;
7+
readonly totalCount: number;
8+
}
9+
export interface PaginatedResponse<I extends Item> {
10+
readonly data: I[];
11+
readonly pagination: PaginationMetadata;
12+
}

dist/interfaces/PaginatedResults.js

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/interfaces/PaginatedResults.js.map

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/interfaces/cursorResult.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,5 @@ export default interface CursorResult {
44
readonly after: Cursor;
55
readonly hasBefore: boolean;
66
readonly hasAfter: boolean;
7+
readonly totalCount?: number;
78
}

src/interfaces/CursorResult.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,5 @@ export default interface CursorResult {
55
readonly after: Cursor;
66
readonly hasBefore: boolean;
77
readonly hasAfter: boolean;
8+
readonly totalCount?: number;
89
}
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
import { OutgoingHttpHeaders } from "http";
2+
3+
export interface EnvelopedResponse<T> {
4+
readonly status: number;
5+
readonly body: T;
6+
readonly headers: OutgoingHttpHeaders;
7+
}

src/interfaces/PaginatedResults.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
import Item from './Item';
2+
3+
export interface PaginationMetadata {
4+
readonly hasAfter: boolean;
5+
readonly hasBefore: boolean;
6+
readonly after: string | null;
7+
readonly before: string | null;
8+
readonly totalCount: number;
9+
}
10+
export interface PaginatedResponse<I extends Item> {
11+
readonly data: I[];
12+
readonly pagination: PaginationMetadata;
13+
}

0 commit comments

Comments
 (0)