digitalbazaar / digitalbazaar/http-client
Add documentation and usage for searchParams feature
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Description
Need to compose a query URL like https://example.com?a=foo,b=bar
the searchParams API is for you! It also takes care of encoding the params properly.
https://github.com/sindresorhus/ky#searchparams
https://github.com/sindresorhus/ky/blob/master/index.js#L275
https://repl.it/repls/IncomparableNimbleStaff
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Ky searchParams documentation, index.js#L275, and the Repl example to understand the API and its encoding behavior. Add project documentation showing how to compose a query URL with searchParams; done means the usage and resulting URL are clear and the parameters are documented as encoded correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100