koajs / koajs/send

[fix] Incorrect require statement in README.MD

Open
#152 0 comments 0 reactions 0 assignees View on GitHub
bug
Dominant language
TypeScript
Stars
433
Forks
86
PR merge metrics
No merged PRs in 30d

Description

## Describe the bug

With the move to @koa/send, the correct way to require the library is using:

const { send } = require('@koa/send')

However, the README.md documentation still refers to:
const send = require('@koa/send')

## Checklist

- [X] I have searched through GitHub issues for similar issues.
- [X] I have completely read through the README and documentation.
- [ ] I have tested my code with the latest version of Node.js and this package and confirmed it is still not working.

Contributor guide

Open the contributing guide

Research direction

Start by locating the @koa/send require example in README.md and compare it with the syntax shown in the issue. Done means the README uses the correct require form for the package's current API; no test is mentioned in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, node.js
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.