Skip to content

Commit bfa0f71

Browse files
fix(types): serializers now take optional meta as second argument (#798)
1 parent afc9151 commit bfa0f71

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

types/index.d.ts

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,9 +113,14 @@ interface RecordsSerialized {
113113
included: Record<string, unknown>[],
114114
}
115115

116+
interface Meta {
117+
count: number,
118+
[k: string]: any,
119+
}
120+
116121
export class AbstractRecordTool<T> {
117122
constructor(model: Model<T>, user: User, query: Record<string, any>)
118-
serialize(records: Document<T> | Document<T>[]): Promise<RecordsSerialized>;
123+
serialize(records: Document<T> | Document<T>[], meta?: Meta): Promise<RecordsSerialized>;
119124
}
120125

121126
export class RecordGetter<T> extends AbstractRecordTool<T> {
@@ -155,7 +160,7 @@ export class RecordsRemover<M extends Model<any>> extends AbstractRecordTool<M>
155160

156161
export class RecordSerializer<T> {
157162
constructor(model: { name: string } | Model<T>, user?: User, query?: Query);
158-
serialize(records: Record<string, any> | Record<string, any>[]): Promise<RecordsSerialized>;
163+
serialize(records: Record<string, any> | Record<string, any>[], meta?: Meta): Promise<RecordsSerialized>;
159164
}
160165

161166
// Optional middleware(s) related to the perf

0 commit comments

Comments
 (0)