Skip to content

Commit f8c50cf

Browse files
authored
fix(types): serializers now take optional meta as second argument (#922)
1 parent 0036a93 commit f8c50cf

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
@@ -103,9 +103,14 @@ interface RecordsSerialized {
103103
included: Record<string, unknown>[],
104104
}
105105

106+
interface Meta {
107+
count: number,
108+
[k: string]: any,
109+
}
110+
106111
export class AbstractRecordTool<M extends Sequelize.Model> {
107112
constructor(model: Sequelize.ModelCtor<M>, user: User, query: Query)
108-
serialize(records: M | M[]): Promise<RecordsSerialized>;
113+
serialize(records: M | M[], meta?: Meta): Promise<RecordsSerialized>;
109114
}
110115

111116
export class RecordGetter<M extends Sequelize.Model> extends AbstractRecordTool<M> {
@@ -145,7 +150,7 @@ export class RecordsRemover<M extends Sequelize.Model> extends AbstractRecordToo
145150

146151
export class RecordSerializer {
147152
constructor(model: { name: string } | Sequelize.ModelCtor<any>, user?: User, query?: Query);
148-
serialize(records: Record<string, any> | Record<string, any>[], meta: Record<string, any>): Promise<RecordsSerialized>;
153+
serialize(records: Record<string, any> | Record<string, any>[], meta?: Meta): Promise<RecordsSerialized>;
149154
}
150155

151156
// Everything related to Forest permissions

0 commit comments

Comments
 (0)