Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updating paramsSerializer docs for all languages #177

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
18 changes: 14 additions & 4 deletions posts/ar/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,20 @@ These are the available config options for making requests. Only the `url` is re
ID: 12345
},

// `paramsSerializer` is an optional function in charge of serializing `params`
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` is an optional config that allows you to customize serializing `params`.
paramsSerializer: {

//Custom encoder function which sends key/value pairs in an iterative fashion.
encode?: (param: string): string => { /* Do custom operations here and return transformed string */ },

// Custom serializer function for the entire parameter. Allows user to mimic pre 1.x behaviour.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Configuration for formatting array indexes in the params.
indexes: false // Three available options:
// (1) indexes: null (leads to no brackets),
// (2) (default) indexes: false (leads to empty brackets),
// (3) indexes: true (leads to brackets with indexes).
},

// `data` is the data to be sent as the request body
Expand Down
18 changes: 14 additions & 4 deletions posts/es/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,20 @@ Estas son las opciones de configuración disponibles para hacer peticiones. Solo
ID: 12345
},

// `paramsSerializer` es una funcion opcional a cargo de serializar `params`
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` es una configuración opcional que le permite personalizar la serialización de `params`.
paramsSerializer: {

//Función de codificador personalizada que envía pares clave/valor de forma iterativa.
encode?: (param: string): string => { /* Realice operaciones personalizadas aquí y devuelva una cadena transformada */ },

// Función de serializador personalizado para todo el parámetro. Permite al usuario imitar el comportamiento anterior a 1.x.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Configuración para formatear índices de matriz en los parámetros.
indexes: false // Tres opciones disponibles:
// (1) indexes: null (no conduce a corchetes),
// (2) (default) indexes: false (conduce a corchetes vacíos),
// (3) indexes: true (conduce a corchetes con índices).
},

// `data` es el data a ser enviado como el cuerpo de la petición
Expand Down
17 changes: 13 additions & 4 deletions posts/fa/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,19 @@ next_link: '/docs/res_schema'
ID: 12345
},

// `paramsSerializer` یک عملکرد اختیاری است که وظیفه سریال سازی `params` را بر عهده دارد
// (به عنوان مثال، https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// 'paramsSerializer' یک پیکربندی اختیاری است که به شما امکان می‌دهد سریال‌سازی 'params' را سفارشی کنید
paramsSerializer: {

//عملکرد رمزگذار سفارشی که جفت های کلید/مقدار را به صورت تکراری ارسال می کند.
encode?: (param: string): string => { /* عملیات سفارشی را در اینجا انجام دهید و رشته تبدیل شده را برگردانید */ },

// عملکرد سریالساز سفارشی برای کل پارامتر. به کاربر امکان تقلید از رفتار قبل از 1.x را می دهد.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//پیکربندی برای قالب بندی شاخص های آرایه در پارامترها.
indexes: false // سه گزینه موجود: (1) indexes: null (منجر به عدم وجود براکت می شود),
// (2) (default) indexes: false (منجر به پرانتزهای خالی می شود),
// (3) indexes: true (منجر به براکت هایی با شاخص می شود).
},

// `data` داده ای است که به عنوان بدنه درخواست ارسال می شود
Expand Down
22 changes: 17 additions & 5 deletions posts/fr/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,23 @@ Voici les différentes options de configuration que vous pouvez utiliser pour fa
ID: 12345
},

// `paramsSerializer` est une fonction optionnelle qui permet de définir
// comment `params` doit être sérialisé (avec https://www.npmjs.com/package/qs
// ou http://api.jquery.com/jquery.param/ par exemple).
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` est une configuration facultative qui vous permet de
// personnaliser la sérialisation des `params`.
paramsSerializer: {

//Fonction d'encodeur personnalisée qui envoie des paires clé/valeur de manière itérative.
encode?: (param: string): string =>
{ /* Effectuez des opérations personnalisées ici et renvoyez la chaîne transformée */ },

// Fonction de sérialiseur personnalisé pour l'ensemble du paramètre.
// Permet à l'utilisateur d'imiter le comportement d'avant 1.x.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Configuration pour le formatage des index de tableau dans les paramètres.
indexes: false // Trois options disponibles:
// (1) indexes: null (ne mène à aucune parenthèse),
// (2) (default) indexes: false (mène à des parenthèses vides),
// (3) indexes: true (mène à des parenthèses avec des index).
},

// `data` correspond aux données qui constitueront le corps de la requête.
Expand Down
18 changes: 14 additions & 4 deletions posts/ja/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,20 @@ next_link: '/docs/res_schema'
ID: 12345
},

// `paramsSerializer` は、 `params` のシリアライズを担当するオプションの関数です。
// (たとえば、https://www.npmjs.com/package/qs、http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` は、`params` のシリアル化をカスタマイズできるオプションの設定です。
paramsSerializer: {

//キーと値のペアを反復的に送信するカスタム エンコーダー関数。
encode?: (param: string): string => { /* ここでカスタム操作を実行し、変換された文字列を返します */ },

// パラメーター全体のカスタム シリアライザー関数。ユーザーが 1.x より前の動作を模倣できるようにします。
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//params で配列インデックスをフォーマットするための構成。
indexes: false // 利用可能な 3 つのオプション:
// (1) indexes: null (括弧がなくなる),
// (2) (default) indexes: false (空の括弧につながります),
// (3) indexes: true (インデックス付きの括弧につながります).
},

// `data` はリクエスト ボディとして送信されるデータです。
Expand Down
18 changes: 14 additions & 4 deletions posts/kr/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,20 @@ next_link: '/kr/docs/res_schema'
ID: 12345
},

// `paramsSerializer`는 `params`의 시리얼라이즈를 담당하는 옵션 함수입니다.
// (예: https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer`는 `params` 직렬화를 맞춤설정할 수 있는 선택적 구성입니다.
paramsSerializer: {

//반복적인 방식으로 키/값 쌍을 보내는 사용자 정의 인코더 기능입니다.
encode?: (param: string): string => { /* 여기에서 사용자 정의 작업을 수행하고 변환된 문자열을 반환합니다. */ },

// 전체 매개변수에 대한 사용자 정의 직렬 변환기 기능입니다. 사용자가 1.x 이전 동작을 모방할 수 있습니다.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//매개변수의 배열 인덱스 형식을 지정하기 위한 구성입니다.
indexes: false // 사용 가능한 세 가지 옵션:
// (1) indexes: null (대괄호가 없습니다.),
// (2) (default) indexes: false (빈 괄호로 이어짐),
// (3) indexes: true (인덱스가 있는 괄호로 연결됨).
},

// `data`는 요청 바디로 전송될 데이터입니다.
Expand Down
18 changes: 14 additions & 4 deletions posts/ku/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,20 @@ next_link: "/ku/docs/res_schema"
ID: 12345
},

// ـەکان`params` کردنی serializing فەنکشنێکی بژاردەییە بەرپرسە لە
// (https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/ نموونە)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` ڕێکخستنێکی هەڵبژاردەیە کە ڕێگەت پێدەدات زنجیرەییکردنی `params` خۆت ڕێکبخەیت.
paramsSerializer: {

//فەنکشنی ئینکۆدەری تایبەت کە جووتە کلیل/بەهاکان بە شێوەیەکی دووبارەبووەوە دەنێرێت.
encode?: (param: string): string => { /* لێرەدا ئۆپەراسیۆنە تایبەتەکان ئەنجام بدە و ڕیزێکی گۆڕاو بگەڕێنەرەوە */ },

// فەنکشنی زنجیرەیی تایبەت بۆ تەواوی پارامێتەرەکە. ڕێگە بە بەکارهێنەر دەدات ڕەفتاری پێش 1.x وەربگرێت.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//ڕێکخستن بۆ فۆرماتکردنی ئیندێکسی ڕیزبەندی لە پارامەکاندا.
indexes: false // سێ بژاردەی بەردەست: ١.
// (1) indexes: null (دەبێتە هۆی ئەوەی کە هیچ کەوانەیەک نەبێت),
// (2) (default) indexes: false (دەبێتە هۆی کەوانە بەتاڵەکان),
// (3) indexes: true (دەچێتە سەر کەوانەکان کە ئیندێکسیان تێدایە).
},

// بریتییە لەو داتاییە کە دەنێردرێت وەکو لاشەی داواکارییەکە `data`
Expand Down
18 changes: 14 additions & 4 deletions posts/ptBR/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,10 +46,20 @@ Estas são as configurações opcionais disponíveis para fazer uma requisição
ID: 12345
},

// `paramsSerializer` é uma função opcional que comanda a serialização dos `params`
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` é uma configuração opcional que permite personalizar a serialização de `params`.
paramsSerializer: {

//Função de codificador personalizado que envia pares chave/valor de forma iterativa.
encode?: (param: string): string => { /* Faça operações personalizadas aqui e retorne a string transformada */ },

// Função serializadora personalizada para todo o parâmetro. Permite ao usuário imitar o comportamento anterior à 1.x.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Configuração para formatação de índices de array nos parâmetros.
indexes: false // Três opções disponíveis:
// (1) indexes: null (não leva a colchetes),
// (2) (default) indexes: false (leva a colchetes vazios),
// (3) indexes: true (leva a colchetes com índices).
},

// `data` são os dados a serem enviados no corpo da requisição
Expand Down
19 changes: 15 additions & 4 deletions posts/ru/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,21 @@ next_link: '/docs/res_schema'
ID: 12345
},

// `paramsSerializer` это дополнительная функция, отвечающая за сериализацию `params`
// (например https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` — это дополнительная конфигурация, которая позволяет вам настроить сериализацию `params`.
paramsSerializer: {

//Пользовательская функция кодировщика, которая итеративно отправляет пары ключ/значение.
encode?: (param: string): string =>
{ /* Выполняйте здесь пользовательские операции и возвращайте преобразованную строку. */ },

// Пользовательская функция сериализации для всего параметра. Позволяет пользователю имитировать поведение до версии 1.x.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Конфигурация форматирования индексов массива в параметрах.
indexes: false // Три доступных варианта:
// (1) indexes: null (приводит к отсутствию скобок),
// (2) (default) indexes: false (приводит к пустым скобкам),
// (3) indexes: true (приводит к скобкам с индексами).
},

// `data` - это данные, которые посылаются как тело запроса
Expand Down
18 changes: 14 additions & 4 deletions posts/tr/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,10 +53,20 @@ Bunlar, istek yapmak için mevcut konfigürasyon seçenekleridir. Yalnızca `url
ID: 12345
},

// `paramsSerializer`, `params`ın dizileştirilmesinden (serialize) sorumlu isteğe bağlı bir işlevdir
// (örneğin: https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// 'paramsSerializer', 'params' serileştirmesini özelleştirmenize olanak tanıyan isteğe bağlı bir yapılandırmadır.
paramsSerializer: {

//Anahtar/değer çiftlerini yinelemeli bir şekilde gönderen özel kodlayıcı işlevi.
encode?: (param: string): string => { /* Burada özel işlemler yapın ve dönüştürülmüş dizeyi döndürün */ },

// Parametrenin tamamı için özel serileştirici işlevi. Kullanıcının 1.x öncesi davranışı taklit etmesine olanak tanır.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Paramlardaki dizi dizinlerini biçimlendirmek için yapılandırma.
indexes: false // Mevcut üç seçenek:
// (1) indexes: null (parantezlerin olmamasına yol açar),
// (2) (default) indexes: false (boş parantezlere yol açar),
// (3) indexes: true (indeksli parantezlere yol açar).
},

// `data` istek gövdesi olarak gönderilecek veridir
Expand Down
18 changes: 14 additions & 4 deletions posts/uk/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,20 @@ next_link: '/uk/docs/res_schema'
ID: 12345
},

// `paramsSerializer` - це додаткова функція, яка відповідає за серіалізацію` params`
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` — це додаткова конфігурація, яка дозволяє налаштувати серіалізацію `params`.
paramsSerializer: {

//Функція спеціального кодувальника, яка надсилає пари ключ/значення ітеративним способом.
encode?: (param: string): string => { /* Виконуйте спеціальні операції тут і повертайте перетворений рядок */ },

// Спеціальна функція серіалізатора для всього параметра. Дозволяє користувачеві імітувати поведінку до 1.x.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Конфігурація для форматування індексів масиву в параметрах.
indexes: false // Three available options:
// (1) indexes: null (призводить до відсутності дужок),
// (2) (default) indexes: false (призводить до порожніх дужок),
// (3) indexes: true (шкоду до порожніх дужок).
},

// `data` - це дані, які надсилаються як тіло запиту
Expand Down
18 changes: 14 additions & 4 deletions posts/vi/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,10 +49,20 @@ next_link: '/vi/docs/res_schema'
ID: 12345
},

// `paramsSerializer` là hàm tùy chọn để đảm nhiệm tuần tự hóa `params`.
// (vd https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` là một cấu hình tùy chọn cho phép bạn tùy chỉnh việc tuần tự hóa `params`.
paramsSerializer: {

//Chức năng mã hóa tùy chỉnh gửi các cặp khóa/giá trị theo kiểu lặp lại.
encode?: (param: string): string => { /* Thực hiện các thao tác tùy chỉnh ở đây và trả về chuỗi đã chuyển đổi */ },

// Chức năng tuần tự hóa tùy chỉnh cho toàn bộ tham số. Cho phép người dùng bắt chước hành vi trước 1.x.
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//Cấu hình để định dạng chỉ mục mảng trong params.
indexes: false // Ba tùy chọn có sẵn:
// (1) indexes: null (dẫn đến không có dấu ngoặc),
// (2) (default) indexes: false (dẫn đến dấu ngoặc trống),
// (3) indexes: true (dẫn đến dấu ngoặc có chỉ mục).
},

// `data` là dữ liệu làm phần thân request để được gửi đi.
Expand Down
18 changes: 14 additions & 4 deletions posts/zh/req_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,20 @@ next_link: '/zh/docs/res_schema'
ID: 12345
},

// `paramsSerializer`是可选方法,主要用于序列化`params`
// (e.g. https://www.npmjs.com/package/qs, http://api.jquery.com/jquery.param/)
paramsSerializer: function (params) {
return Qs.stringify(params, {arrayFormat: 'brackets'})
// `paramsSerializer` 是一个可选配置,允许您自定义序列化 `params`。
paramsSerializer: {

//自定义编码器函数,以迭代方式发送键/值对。
encode?: (param: string): string => { /* 在这里进行自定义操作并返回转换后的字符串 */ },

// 整个参数的自定义序列化器函数。允许用户模仿 1.x 之前的行为。
serialize?: (params: Record<string, any>, options?: ParamsSerializerOptions ),

//用于格式化参数中数组索引的配置。
indexes: false // 三个可用选项:
// (1) indexes: null (导致没有括号),
// (2) (default) indexes: false (导致空括号),
// (3) indexes: true (引导空字符串).
},

// `data` 是作为请求体被发送的数据
Expand Down