locutus/esm/php/url/http_build_query.js

Locutus other languages' standard libraries to JavaScript for fun and educational purposes

import { rawurlencode as _rawurlencode } from "../url/rawurlencode.js";
import { urlencode as _urlencode } from "../url/urlencode.js";
export function http_build_query(formdata, numericPrefix, argSeparator, encType) {
    //  discuss at: https://locutus.io/php/http_build_query/
    // original by: Kevin van Zonneveld (https://kvz.io)
    // improved by: Legaev Andrey
    // improved by: Michael White (https://getsprink.com)
    // improved by: Kevin van Zonneveld (https://kvz.io)
    // improved by: Brett Zamir (https://brett-zamir.me)
    //  revised by: stag019
    //    input by: Dreamer
    // bugfixed by: Brett Zamir (https://brett-zamir.me)
    // bugfixed by: MIO_KODUKI (https://mio-koduki.blogspot.com/)
    // improved by: Will Rowe
    //      note 1: If the value is null, key and value are skipped in the
    //      note 1: http_build_query of PHP while in locutus they are not.
    //   example 1: http_build_query({foo: 'bar', php: 'hypertext processor', baz: 'boom', cow: 'milk'}, '', '&')
    //   returns 1: 'foo=bar&php=hypertext+processor&baz=boom&cow=milk'
    //   example 2: http_build_query({'php': 'hypertext processor', 0: 'foo', 1: 'bar', 2: 'baz', 3: 'boom', 'cow': 'milk'}, 'myvar_')
    //   returns 2: 'myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&php=hypertext+processor&cow=milk'
    //   example 3: http_build_query({foo: 'bar', php: 'hypertext processor', baz: 'boom', cow: 'milk'}, '', '&', 'PHP_QUERY_RFC3986')
    //   returns 3: 'foo=bar&php=hypertext%20processor&baz=boom&cow=milk'
    let encodeFunc;
    switch (encType) {
        case 'PHP_QUERY_RFC3986':
            encodeFunc = _rawurlencode;
            break;
        case 'PHP_QUERY_RFC1738':
        default:
            encodeFunc = _urlencode;
            break;
    }
    const tmp = [];
    const _httpBuildQueryHelper = function (key, val, separator) {
        const nested = [];
        if (val === true) {
            val = '1';
        }
        else if (val === false) {
            val = '0';
        }
        if (val !== null) {
            if (typeof val === 'object') {
                if (Array.isArray(val)) {
                    for (let nestedIndex = 0; nestedIndex < val.length; nestedIndex += 1) {
                        const nestedValue = val[nestedIndex];
                        if (typeof nestedValue !== 'undefined' && nestedValue !== null) {
                            nested.push(_httpBuildQueryHelper(key + '[' + nestedIndex + ']', nestedValue, separator));
                        }
                    }
                }
                else {
                    for (const [nestedKey, nestedValue] of Object.entries(val)) {
                        if (typeof nestedValue !== 'undefined' && nestedValue !== null) {
                            nested.push(_httpBuildQueryHelper(key + '[' + nestedKey + ']', nestedValue, separator));
                        }
                    }
                }
                return nested.join(separator);
            }
            else {
                return encodeFunc(key) + '=' + encodeFunc(String(val));
            }
        }
        else {
            return '';
        }
    };
    const separator = argSeparator || '&';
    if (Array.isArray(formdata)) {
        for (let index = 0; index < formdata.length; index += 1) {
            const value = formdata[index];
            if (typeof value === 'undefined') {
                continue;
            }
            let queryKey = String(index);
            if (numericPrefix) {
                queryKey = String(numericPrefix) + queryKey;
            }
            const query = _httpBuildQueryHelper(queryKey, value, separator);
            if (query !== '') {
                tmp.push(query);
            }
        }
    }
    else {
        for (const [key, value] of Object.entries(formdata)) {
            if (typeof value === 'undefined') {
                continue;
            }
            let queryKey = key;
            if (numericPrefix && !Number.isNaN(Number(queryKey))) {
                queryKey = String(numericPrefix) + queryKey;
            }
            const query = _httpBuildQueryHelper(queryKey, value, separator);
            if (query !== '') {
                tmp.push(query);
            }
        }
    }
    return tmp.join(separator);
}