Skip to content
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.

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

feat: [sc-123950] Update JSDocs for most functions #177

Conversation

cole-abbeduto-particle
Copy link
Contributor

@cole-abbeduto-particle cole-abbeduto-particle commented Dec 4, 2023

Story details: https://app.shortcut.com/particle/story/123950

  • Add today_stats query params to list logic functions API
  • Add scope and archived filters along with page/per_page query params to list ledgers API
  • Add page/per_page query params to list ledger instances API
  • Add JSDoc for constructor options
  • Fix incorrect auth docs on most functions
  • Set strict: true for better TS type checking
  • Add support for basic auth in constructor
  • Fix many function args taking type | undefined instead of marking as optional with [optionName]
  • Update various query JSDocs from string|object to object since we only support object
  • Switch from tabs to 4 spaces in all files

@cole-abbeduto-particle cole-abbeduto-particle marked this pull request as ready for review December 5, 2023 15:54
@cole-abbeduto-particle cole-abbeduto-particle changed the title feat: [sc-123950] Update particle-api-js with Ledger APIs feat: [sc-123950] Update JSDocs for most functions Dec 5, 2023
Copy link
Contributor

@laupow laupow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple of ideas in the comments, but generally it looks good to me.

src/Agent.js Outdated Show resolved Hide resolved
src/Agent.js Outdated Show resolved Hide resolved
@cole-abbeduto-particle cole-abbeduto-particle merged commit 6c0cc71 into master Dec 6, 2023
3 checks passed
@cole-abbeduto-particle cole-abbeduto-particle deleted the feature/sc-123950/update-particle-api-js-with-ledger-apis branch December 6, 2023 19:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants