)
}
diff --git a/src/components/patterns/Signature/Signature.astro b/src/components/patterns/Signature/Signature.astro
index 0acf459310..028a0df229 100644
--- a/src/components/patterns/Signature/Signature.astro
+++ b/src/components/patterns/Signature/Signature.astro
@@ -17,6 +17,8 @@
*
*
*
+ *
+ *
*/
import './Signature.css';
@@ -27,16 +29,18 @@ interface Props {
type?: string;
/** Version the member was added in, e.g. `"v4.16.0"`. */
since?: string;
+ /** Version the member was deprecated in, e.g. `"v4.11.0"`. */
+ deprecated?: string;
/** Heading text for the arguments section. */
attributesTitle?: string;
}
-const { returns, type, since, attributesTitle = 'Arguments' } = Astro.props;
+const { returns, type, since, deprecated, attributesTitle = 'Arguments' } = Astro.props;
const hasReturnsSlot = Astro.slots.has('returns');
const hasReturns = hasReturnsSlot || Boolean(returns);
const hasAttributes = Astro.slots.has('attributes');
-const hasFooter = Boolean(type) || hasReturns || Boolean(since);
+const hasFooter = Boolean(type) || hasReturns || Boolean(since) || Boolean(deprecated);
---
@@ -75,6 +79,12 @@ const hasFooter = Boolean(type) || hasReturns || Boolean(since);
{since}
)}
+ {deprecated && (
+
+ Deprecated in:
+ {deprecated}
+
+ )}
)
}
diff --git a/src/components/patterns/Signature/Signature.css b/src/components/patterns/Signature/Signature.css
index 4fe9ebf9e0..3a0ed97ad4 100644
--- a/src/components/patterns/Signature/Signature.css
+++ b/src/components/patterns/Signature/Signature.css
@@ -58,6 +58,16 @@
font-weight: var(--font-weight-medium);
}
+ .type-tag--deprecated {
+ border-color: var(--color-border-error);
+ background-color: var(--color-bg-error);
+ color: var(--color-text-error);
+ }
+
+ .signature__line--deprecated .signature__line-label {
+ color: var(--color-text-error);
+ }
+
.signature__params {
display: grid;
grid-template-columns: minmax(8rem, 14rem) minmax(0, 1fr);
@@ -148,6 +158,11 @@
color: var(--color-text-primary);
}
+ .param__meta-item--deprecated .param__label,
+ .param__meta-item--deprecated .param__value {
+ color: var(--color-text-error);
+ }
+
.param__desc {
color: var(--color-text-secondary);
diff --git a/src/content/api/4x/api/application/index.mdx b/src/content/api/4x/api/application/index.mdx
index 3be84862c7..c0c557de89 100644
--- a/src/content/api/4x/api/application/index.mdx
+++ b/src/content/api/4x/api/application/index.mdx
@@ -6,6 +6,7 @@ description: Learn about the properties of the Express application object.
import Alert from '@components/primitives/Alert/Alert.astro';
import Signature from '@components/patterns/Signature/Signature.astro';
import Param from '@components/patterns/Signature/Param.astro';
+import PackageManagerCommand from '@components/patterns/PackageManagerCommand/PackageManagerCommand.astro';
The `app` object conventionally denotes the Express application.
Create it by calling the top-level `express()` function exported by the Express module:
@@ -293,6 +294,29 @@ app.delete('/', function (req, res) {
});
```
+### app.del()
+
+
+
+
+ The path for which the middleware function is invoked; same as [app.delete()](#appdelete).
+
+
+ Callback functions; same as [app.delete()](#appdelete).
+
+
+
+
+
+
+`app.del()` is the alias of [`app.delete()`](#appdelete), originally introduced because `delete` was a reserved word in older JavaScript engines. It has emitted a deprecation warning since Express v4.2.0. Use `app.delete()` instead.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
### app.disable()
@@ -817,7 +841,7 @@ although this matches
and this matches too
```
-
+
The following section describes `app.param(callback)`, which is deprecated as of v4.11.0.
diff --git a/src/content/api/4x/api/request/index.mdx b/src/content/api/4x/api/request/index.mdx
index a20725bf14..ce16198130 100644
--- a/src/content/api/4x/api/request/index.mdx
+++ b/src/content/api/4x/api/request/index.mdx
@@ -6,6 +6,7 @@ description: The req object represents the HTTP request and has properties for t
import Alert from '@components/primitives/Alert/Alert.astro';
import Signature from '@components/patterns/Signature/Signature.astro';
import Param from '@components/patterns/Signature/Param.astro';
+import PackageManagerCommand from '@components/patterns/PackageManagerCommand/PackageManagerCommand.astro';
The `req` object represents the HTTP request and has properties for the
request query string, parameters, body, HTTP headers, and so on. In this documentation and by convention,
@@ -220,6 +221,22 @@ console.dir(req.hostname);
// => 'example.com'
```
+### req.host
+
+
+
+
+
+`req.host` is a deprecated alias of [`req.hostname`](#reqhostname) and returns the same value — the hostname with the port number stripped off. It has emitted a deprecation warning since Express v4.5.0. Use `req.hostname` instead.
+
+
+
+```js
+// Host: "example.com:3000"
+console.dir(req.host);
+// => 'example.com'
+```
+
### req.ip
@@ -601,6 +618,26 @@ req.acceptsCharsets('us-ascii');
For more information, or if you have issues or concerns, see [accepts](https://github.com/expressjs/accepts).
+### req.acceptsCharset()
+
+
+
+
+ One or more character sets to test against the request's `Accept-Charset` header.
+
+
+
+
+
+
+`req.acceptsCharset()` is the singular alias of [`req.acceptsCharsets()`](#reqacceptscharsets) and behaves identically. It has emitted a deprecation warning since Express v4.5.0. Use `req.acceptsCharsets()` instead.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
### req.acceptsEncodings()
@@ -626,6 +663,26 @@ req.acceptsEncodings('br');
For more information, or if you have issues or concerns, see [accepts](https://github.com/expressjs/accepts).
+### req.acceptsEncoding()
+
+
+
+
+ One or more encodings to test against the request's `Accept-Encoding` header.
+
+
+
+
+
+
+`req.acceptsEncoding()` is the singular alias of [`req.acceptsEncodings()`](#reqacceptsencodings) and behaves identically. It has emitted a deprecation warning since Express v4.5.0. Use `req.acceptsEncodings()` instead.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
### req.acceptsLanguages()
@@ -656,6 +713,27 @@ req.acceptsLanguages();
For more information, or if you have issues or concerns, see [accepts](https://github.com/expressjs/accepts).
+### req.acceptsLanguage()
+
+
+
+
+ One or more languages to test against the request's `Accept-Language` header. If omitted, all
+ accepted languages are returned as an array.
+
+
+
+
+
+
+`req.acceptsLanguage()` is the singular alias of [`req.acceptsLanguages()`](#reqacceptslanguages) and behaves identically. It has emitted a deprecation warning since Express v4.5.0. Use `req.acceptsLanguages()` instead.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
Express (4.x) source: [request.js line 179](https://github.com/expressjs/express/blob/4.x/lib/request.js#L179)
Accepts (1.3) source: [index.js line 195](https://github.com/jshttp/accepts/blob/f69c19e459bd501e59fb0b1a40b7471bb578113a/index.js#L195)
@@ -752,7 +830,7 @@ For more information, or if you have issues or concerns, see [type-is](https://g
-
+
Deprecated. Use either `req.params`, `req.body` or `req.query`, as applicable.
diff --git a/src/content/api/4x/api/response/index.mdx b/src/content/api/4x/api/response/index.mdx
index dba01d7761..d37499d684 100644
--- a/src/content/api/4x/api/response/index.mdx
+++ b/src/content/api/4x/api/response/index.mdx
@@ -6,6 +6,7 @@ description: The res object represents the HTTP response that an Express app sen
import Alert from '@components/primitives/Alert/Alert.astro';
import Signature from '@components/patterns/Signature/Signature.astro';
import Param from '@components/patterns/Signature/Param.astro';
+import PackageManagerCommand from '@components/patterns/PackageManagerCommand/PackageManagerCommand.astro';
The `res` object represents the HTTP response that an Express app sends when it gets an HTTP request.
@@ -116,7 +117,7 @@ app.get('/', function (req, res) {
### res.append()
-
+
The name of the HTTP response header to append to.
@@ -127,7 +128,6 @@ app.get('/', function (req, res) {
-`res.append()` is supported by Express v4.11.0+
Appends the specified `value` to the HTTP response header `field`. If the header is not already set,
it creates the header with the specified value. The `value` parameter can be a string or an array.
@@ -185,7 +185,7 @@ Clears the cookie with the specified `name` by sending a `Set-Cookie` header tha
This instructs the client that the cookie has expired and is no longer valid. For more information
about available `options`, see [res.cookie()](#rescookie).
-
+
If the `maxAge` or `expires` options are set, the cookie may not be cleared depending on the time
values provided, as Express does not ignore these options. It is therefore recommended to omit
@@ -340,7 +340,7 @@ Later you may access this value through the [req.signedCookie](/api/request/#req
The file name for the `Content-Disposition` "filename=" parameter; overrides the name derived from `path`.
-
+
Options forwarded to [res.sendFile()](#ressendfile).
@@ -392,8 +392,6 @@ When the `root` option is provided, Express will validate that the relative path
-The optional `options` argument is supported by Express v4.16.0 onwards.
-
The method invokes the callback function `fn(err)` when the transfer is complete
or when an error occurs. If the callback function is specified and an error occurs,
the callback function must explicitly handle the response process either by
@@ -527,6 +525,10 @@ res.get('Content-Type');
The value to send as JSON. Can be any JSON type: object, array, string, Boolean, number, or
null.
+
+ The HTTP status code, accepted as a positional argument by the old `res.json(obj, status)` and
+ `res.json(status, obj)` signatures. Use [res.status()](#resstatus) instead.
+
@@ -542,6 +544,16 @@ res.json({ user: 'tobi' });
res.status(500).json({ error: 'message' });
```
+
+
+The signature `res.json(obj, status)` has been deprecated since Express v4.2.0 (and the reversed `res.json(status, obj)` since v4.7.0). Set the status separately and chain the call instead: `res.status(status).json(obj)`.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
### res.jsonp()
@@ -549,6 +561,10 @@ res.status(500).json({ error: 'message' });
The value to send as a JSONP response. Can be any JSON type.
+
+ The HTTP status code, accepted as a positional argument by the old `res.jsonp(obj, status)`
+ and `res.jsonp(status, obj)` signatures. Use [res.status()](#resstatus) instead.
+
@@ -584,6 +600,16 @@ res.status(500).jsonp({ error: 'message' });
// => foo({ "error": "message" })
```
+
+
+The signature `res.jsonp(obj, status)` has been deprecated since Express v4.2.0 (and the reversed `res.jsonp(status, obj)` since v4.7.0). Set the status separately and chain the call instead: `res.status(status).jsonp(obj)`.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
### res.links()
@@ -631,7 +657,7 @@ res.location('http://example.com');
res.location('back');
```
-
+
`'back'` was deprecated in 4.21.0, use `req.get('Referrer') || '/'` as an argument instead.
@@ -675,6 +701,16 @@ res.redirect(301, 'http://example.com');
res.redirect('../login');
```
+
+
+The reversed signature `res.redirect(path, status)` (status as the second argument) has been deprecated since Express v4.6.0. Use `res.redirect(status, path)` instead.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
Redirects can be a fully-qualified URL for redirecting to a different site:
```js
@@ -718,7 +754,7 @@ defaulting to `/` when the referer is missing.
res.redirect('back');
```
-
+
`back` redirect was deprecated in 4.21.0, use `req.get('Referrer') || '/'` as an argument instead.
@@ -798,6 +834,11 @@ res.render('user', { name: 'Tobi' }, function (err, html) {
The response body. Strings are sent as HTML; objects and arrays as JSON; Buffers as binary.
+
+ The HTTP status code, accepted as a positional argument by the old `res.send(body, status)`,
+ `res.send(status, body)`, and `res.send(status)` signatures. Use [res.status()](#resstatus) or
+ [res.sendStatus()](#ressendstatus) instead.
+
@@ -839,9 +880,19 @@ res.send({ user: 'tobi' });
res.send([1, 2, 3]);
```
+
+
+The signatures `res.send(body, status)` and `res.send(status)` have been deprecated since Express v4.5.0 (the reversed `res.send(status, body)` since v4.7.0). To set the status, chain the call: `res.status(status).send(body)`. To send only a status code, use [`res.sendStatus()`](#ressendstatus). If you need to send a number as the body, convert it to a string first (for example, `res.send(String(123))`) so it is not interpreted as a status code.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
### res.sendFile()
-
+
The path to the file to transfer. Must be absolute unless the `root` option is set.
@@ -883,8 +934,6 @@ res.send([1, 2, 3]);
-`res.sendFile()` is supported by Express v4.8.0 onwards.
-
Transfers the file at the given `path`. Sets the `Content-Type` response HTTP header field
based on the filename's extension. Unless the `root` option is set in
the options object, `path` must be an absolute path to the file.
@@ -949,6 +998,36 @@ app.get('/user/:uid/photos/:file', function (req, res) {
For more information, or if you have issues or concerns, see [send](https://github.com/pillarjs/send).
+### res.sendfile()
+
+
+
+
+ The path to the file to transfer.
+
+
+ Options for serving the file. In addition to the options accepted by
+ [`res.sendFile()`](#ressendfile), the legacy `hidden` and `from` options are supported (use
+ `dotfiles` and `root` instead).
+
+
+ Callback `fn(err)` invoked when the transfer completes or an error occurs.
+
+
+
+
+
+
+`res.sendfile()` (lower-cased) is the legacy version of [`res.sendFile()`](#ressendfile) and behaves identically. The camel-cased `res.sendFile()` was introduced in Express v4.8.0, and `res.sendfile()` has emitted a deprecation warning since that release. Use `res.sendFile()` instead.
+
+You can update your code automatically with the following codemod:
+
+
+
+
+
+Transfers the file at the given `path`. This is the legacy, lower-cased version of [`res.sendFile()`](#ressendfile) and behaves the same way. Prefer `res.sendFile()` in new code.
+
### res.sendStatus()
diff --git a/src/content/api/4x/api/router/index.mdx b/src/content/api/4x/api/router/index.mdx
index e6a169d2c9..5b5ac1f504 100644
--- a/src/content/api/4x/api/router/index.mdx
+++ b/src/content/api/4x/api/router/index.mdx
@@ -269,7 +269,7 @@ although this matches
and this matches too
```
-
+
The following section describes `router.param(callback)`, which is deprecated as of v4.11.0.