Skip to content

Update jsdoc optional params compatibile with rollup to types file #87

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sparr wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update jsdoc optional params compatibile with rollup to types file #87

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions src/RawAPI.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,7 +268,7 @@ export class RawAPI extends EventEmitter {
* @param {number} x
* @param {number} y
* @param {string} name
* @param {string?} shard
* @param {string} shard=DEFAULT_SHARD
*/
placeSpawn (room, x, y, name, shard = DEFAULT_SHARD) {
return self.req('POST', '/api/game/place-spawn', { name, room, x, y, shard })
Expand Down Expand Up @@ -511,10 +511,10 @@ intent can be an empty object for suicide and unclaim, but the web interface sen
leaderboard: {
/**
* GET /api/leaderboard/list
* @param {number} limit
* @param {"world"|"power"} mode
* @param {number?} offset
* @param {string?} season
* @param {number} limit=10
* @param {"world"|"power"} mode="world"
* @param {number} offset=0
* @param {string} [season]
* @returns {{ ok, list: [ { _id, season, user, score, rank } ], count, users: { <user's _id>: { _id, username, badge: { type, color1, color2, color3, param, flip }, gcl } } }}
*/
list (limit = 10, mode = 'world', offset = 0, season) {
Expand All @@ -526,7 +526,7 @@ intent can be an empty object for suicide and unclaim, but the web interface sen
* GET /api/leaderboard/find
* @param {string} username
* @param {"world"|string} mode
* @param {string?} season An optional date in the format YYYY-MM, if not supplied all ranks in all seasons is returned.
* @param {string} [season] An optional date in the format YYYY-MM, if not supplied all ranks in all seasons is returned.
* @returns {{ ok, _id, season, user, score, rank }}
* - `user` (not `_id`) is the user's _id, as returned by `me` and `user/find`
* - `rank` is 0-based
Expand Down Expand Up @@ -654,7 +654,7 @@ intent can be an empty object for suicide and unclaim, but the web interface sen
* for pushing or pulling code, as documented at http://support.screeps.com/hc/en-us/articles/203022612
* @param {string} branch
* @param {*} modules
* @param {*} _hash
* @param {*} [_hash]
* @returns {Object}
*/
set (branch, modules, _hash) {
Expand Down