Discrepancy in docs vs typescript types for locks

[michaelfarrell76]

What are you doing?

I am attempting to lock a table when I perform a find query. The documentation seems to have a discrepancy in how these locks can be created, however the typescript types do not sync up

The following will produce a type error:

await MigrationLock.findAll({
  where: { isLocked: false },
  transaction,
  lock: true,
});

See below for all of the typescript warnings that also seem to be valid code as stated in the docs here and here

To Reproduce
Steps to reproduce the behavior:

1. Define model MigrationLock using typescript
2. Try to provide lock: true in findAll
3. See typescript error

What do you expect to happen?

I want to be able to have a type-safe find lock on a table

What is actually happening?

Typescript keeps yelling at me

Environment

Dialect:

• mysql
• postgres
• sqlite
• mssql
• any

Dialect library version: 10.4
Database version: 10.4
Sequelize version: 5.9.4
Node Version: v10.15.0
OS: OSX Mojave 10.14.5

If TypeScript related: TypeScript version: XXX
Tested with latest release:

• No
• Yes, specify that version: 3.5.2

[aecorredor]

Having the same issue here.

When I do something like:

const user = await models.sequelize.transaction(async t => {
  const contest = await models.Contest.findByPk(id, {
    transaction: t,
    lock: true,
  });

  // ...rest of the code, returns user at the end
});

I get Type 'true' is not assignable to type 'LOCK | { level: LOCK; of: typeof Model; } | undefined'.

[aecorredor]

Any updates?

[papb]

@aecorredor No, would you like to try to make a PR?

[aecorredor]

@papb sure thing, I'll give it a shot, just wanted to make sure that it was indeed a bug in the types and not me doing something wrong.

[papb]

@aecorredor Ah, ok! Indeed looks like a bug. Thank you very much. I will fix the issue label

[aecorredor]

@papb PR for this issue is here: #11620. Let me know if everything looks good or if I need to do something else. It's my first time making a PR for this repo, so I might have missed something.

[github-actions]

This issue has been automatically marked as stale because it has been open for 14 days without activity. It will be closed if no further activity occurs within the next 14 days. If this is still an issue, just leave a comment or remove the "stale" label. 🙂

[ephys]

Looks like this was fixed by #11620