Add documentation and usage for searchParams feature
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- javascript
- Domain
- documentation
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.
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
- Dominant language
- JavaScript
- Stars
- 2
- Forks
- 8
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
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.
More from digitalbazaar/http-client
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
digitalbazaar/http-client#45 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
digitalbazaar/http-client#44 ·
-
Keep an eye on `node:undici` (or similar) exposing `undici` in `node` and remove `undici` dependencyOpen
Difficulty 3/5 1-2 days Newbie friendliness 30/100
digitalbazaar/http-client#43 ·
-
Difficulty 5/5 Over a week Newbie friendliness 15/100
digitalbazaar/http-client#37 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
digitalbazaar/http-client#33 ·
All issues in digitalbazaar/http-client
Similar issues
-
external-issue to-triage
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
LearningCircuit/local-deep-research#7067 ·
Maintainers usually reply within 1 day
-
automated issue report
Difficulty 1/5 Under an hour Newbie friendliness 65/100
lirantal/discoprint#32 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
Maintainers usually reply within 1 day