slackapi / slackapi/deno-slack-api
Return Response instead of BaseResponse
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 45
- Forks
- 18
- PR merge metrics
- No merged PRs in 30d
Description
Description
Currently the base BaseSlackClient defines the return type of apiCall and response as Promise<BaseResponse> which represents the json payload returned by the Slack API.
This is an issue since users may want to access more then just the json payload from the Response such as headers and status codes.
In the next major release apiCall and response should return some version of Promise<[Response](https://deno.com/deploy/docs/runtime-response)> instead. It will be a breaking change.
Requirements (place an x in each of the [ ])
- I've read and understood the Contributing guidelines and have done my best effort to follow them.
- I've read and agree to the Code of Conduct.
- I've searched for any related issues and avoided creating a duplicate issue.
Contributor guide
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 in src/types.ts at BaseSlackClient and inspect the apiCall and response return types, then trace their usages in the client. Determine the appropriate Response-based return shape for the next major release; done means callers can access the Slack response headers and status codes instead of only the JSON payload.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100