knex / knex/documentation

Logger.deprecate signature

Open
#578 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Vue
Stars
399
Forks
232
PR merge metrics
No merged PRs in 30d

Description

[Documentation](https://knexjs.org/guide/#log) says that the `Logger.deprecate` method signature is

```
deprecate(message) {},
```

while according to [source code](https://github.com/knex/knex/blob/3.1.0/lib/logger.js#L57C3-L57C12) and [types](https://github.com/knex/knex/blob/3.1.0/types/index.d.ts#L3125) it should be

```
deprecate?: (method: string, alternative: string) => void;
```

Contributor guide

No contributing guide indexed for this repository

Research direction

Compare the Logger.deprecate signature in the linked documentation with lib/logger.js and types/index.d.ts. Update the documentation to match the source and type definition, then verify the Logger documentation page shows the corrected signature.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.