model.count doesn't always return a Promise<number>

[mjdavidson]

sequelize/types/lib/model.d.ts

Line 1751 in 728707c

public static count(options?: CountOptions): Promise<number>;

if you use group/attributes it will return an array of objects

[SimonSchick]

Could you add a specific overload that when group is defined it yields { [key: string]: number }?

You'd have to create an interface like interface CountWithOptions extends CountOptions { group:/*note the lack of ?*/ GroupOptions/*or whatever it was called*/ }

[mjdavidson]

The fix is incorrect. It should be { [key:string]: string }[],
also if you group by multiple columns this should be accounted for,

eg:

const observations = await Observation.count({
  include: [
    {
      model: User,
      association: 'createdBy',
      attributes: ['id', 'name', 'avatar']
    },
  ],
  attributes: ['createdBy.name', 'createdBy.color', 'createdBy.id'],
  group: ['createdBy.name', 'createdBy.color', 'createdBy.id']
});

returns

[ { "name": "Matt Davidson",                                                   
    "color": "#0000",                                                           
    "id": "aa6776b8-d402-4817-8335-d12257d13df4",                                
    "count": "1" } ]      

Note that count is not a number it's actually a string

[mjdavidson]

@sushantdhiman

[DG-Wangtao]

Maybe it should be

Promise<{ [key: string]: object }>

[papb]

@mjdavidson Is this still an issue?

[mjdavidson]

don't think so,
https://github.com/sequelize/sequelize/blob/v5.10.3/types/lib/model.d.ts#L1811
stopped using sequelize with typescript... was 'too hard basket'