From dff74ae374b75ad1b99cb1050fe4a4c52cf4b9f5 Mon Sep 17 00:00:00 2001 From: Michael Di Prisco Date: Sat, 26 Aug 2023 19:50:03 +0200 Subject: [PATCH] docs: linting documentation notes (#5791) --- README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 871246a..c6318df 100644 --- a/README.md +++ b/README.md @@ -215,7 +215,7 @@ async function getUser() { } ``` -> **Note** `async/await` is part of ECMAScript 2017 and is not supported in Internet +> **Note**: `async/await` is part of ECMAScript 2017 and is not supported in Internet > Explorer and older browsers, so use with caution. Performing a `POST` request @@ -961,8 +961,7 @@ axios.post('https://something.com/', querystring.stringify({ foo: 'bar' })); You can also use the [`qs`](https://github.com/ljharb/qs) library. -> **Note** -> The `qs` library is preferable if you need to stringify nested objects, as the `querystring` method has [known issues](https://github.com/nodejs/node-v0.x-archive/issues/1665) with that use case. +> **Note**: The `qs` library is preferable if you need to stringify nested objects, as the `querystring` method has [known issues](https://github.com/nodejs/node-v0.x-archive/issues/1665) with that use case. ### 🆕 Automatic serialization to URLSearchParams @@ -1078,8 +1077,7 @@ Axios FormData serializer supports some special endings to perform the following - `{}` - serialize the value with JSON.stringify - `[]` - unwrap the array-like object as separate fields with the same key -> **Note** -> unwrap/expand operation will be used by default on arrays and FileList objects +> **Note**: unwrap/expand operation will be used by default on arrays and FileList objects FormData serializer supports additional options via `config.formSerializer: object` property to handle rare cases: