can-param.md

@module {function} can-param can-param @parent can-routing @collection can-infrastructure @package ./package.json @group can-param.methods 0 Methods @description Serialize an object or array into a query string.

@signature param(object)

Serializes an object or array into a query string useful for making Ajax requests. param handles nested objects and arrays. It uses encodeURIComponent to escape values and keys.

import { param } from "can";

param( { foo: "bar" } );          //-> "foo=bar"
param( { foo: [ "bar", "baz" ] } ); //-> "foo[]=bar&foo[]=baz"
param( { foo: { bar: "baz" } } );    //-> "foo[bar]=baz"
param( { foo: "bar & baz" } );    //-> "foo=bar+%26+baz"

This is exported as param on [can-namespace].

@param {Object} object An object or array. @return {String} The params formatted into a form-encoded string.

@body

Try it

Run the following example on CodePen to play around with this package:

<script type="module">
import { param } from "can";

var parameters = {canjs: 'awesome'};
var queryString = param(parameters);
console.log(queryString);
</script>

@codepen