overleaf/services
Antoine Clausse 01188589f8 Add some JSDoc types to @overleaf/logger (#19153)
* Add some JSDoc types to `@overleaf/logger`

* Update `logger.error` calls

* Fixup `logger.err` JSDoc

* Update `logger.err` calls

* Fix `args` type

* Remove "Error message" description

* Replace `arguments` by actual arguments of the method

* Fix: "ESLint: Unnecessary '.apply()'.(no-useless-call)"

* Add JSDoc params to `debug` `info` `warn`

* Remove extra `args` param in JSDoc so developers aren't invited to use it

Not sure if this is the best thing to do because it creates a warning in the IDE: "Parameter args is not described in JSDoc"

* Add comment about serialization of `err` `req` `res`

* Allow strings as first param in `debug` `info` `warn`

* Fix syntax for optional parameters in JSDoc

* Add 2 signatures, to avoid "string, string" params

* Fix `@signature` names copy-pastes

Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com>

* Revert the double `@param attributes`. It doesn't work

---------

Co-authored-by: Jakob Ackermann <jakob.ackermann@overleaf.com>
GitOrigin-RevId: 086dee8bbf30d577c5e1f844a9df5e518c46aca7
2024-06-28 08:04:25 +00:00
..
chat Explicitly specify latest version of async 2024-06-17 08:04:00 +00:00
clsi Explicitly specify latest version of async 2024-06-17 08:04:00 +00:00
contacts Explicitly specify latest version of async 2024-06-17 08:04:00 +00:00
docstore Explicitly specify latest version of async 2024-06-17 08:04:00 +00:00
document-updater Merge pull request #18906 from overleaf/em-migrate-existing-histories-2 2024-06-19 08:05:02 +00:00
filestore Add some JSDoc types to @overleaf/logger (#19153) 2024-06-28 08:04:25 +00:00
git-bridge Merge pull request #18402 from overleaf/msm-git-bridge-pom 2024-06-17 08:04:21 +00:00
history-v1 Merge pull request #18088 from overleaf/ab-session-secret-rotation 2024-05-27 10:23:33 +00:00
notifications Explicitly specify latest version of async 2024-06-17 08:04:00 +00:00
project-history Merge pull request #18906 from overleaf/em-migrate-existing-histories-2 2024-06-19 08:05:02 +00:00
real-time Merge pull request #19098 from overleaf/jpa-graceful-shutdown-tests 2024-06-25 11:12:43 +00:00
spelling Explicitly specify latest version of async 2024-06-17 08:04:00 +00:00
web Add some JSDoc types to @overleaf/logger (#19153) 2024-06-28 08:04:25 +00:00