qss

WebJar for qss

License	MIT
GroupId	org.webjars.npm
ArtifactId	qss
Last Version	2.0.3
Release Date	Mar 25, 2019
Type	jar
Description	qss WebJar for qss
Project URL	http://webjars.org
Source Code Management	https://github.com/lukeed/qss

Download qss

Filename	Size
qss-2.0.3.pom
qss-2.0.3.jar	7 KB
qss-2.0.3-sources.jar	22 bytes
qss-2.0.3-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/qss/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>qss</artifactId>
    <version>2.0.3</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/qss/
implementation 'org.webjars.npm:qss:2.0.3'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/qss/
implementation ("org.webjars.npm:qss:2.0.3")

Apache Buildr

'org.webjars.npm:qss:jar:2.0.3'

Apache Ivy

<dependency org="org.webjars.npm" name="qss" rev="2.0.3">
  <artifact name="qss" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='qss', version='2.0.3')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "qss" % "2.0.3"

Leiningen

[org.webjars.npm/qss "2.0.3"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

qss

A tiny (305B) browser utility for stringifying a query Object.

You should only consider using this within a browser context since Node's built-in querystring.stringify is much faster and should be used in a Node environment! An ideal use case is serializing a query object before an API request is sent.

This module exposes three module definitions:

• ES Module: dist/qss.mjs
• CommonJS: dist/qss.js
• UMD: dist/qss.min.js

Install

$ npm install --save qss

Usage

import { encode, decode } from 'qss';

encode({ foo:'hello', bar:[1,2,3], baz:true });
//=> 'foo=hello&bar=1&bar=2&bar=3&baz=true'

encode({ foo:123 }, '?');
//=> '?foo=123'

encode({ bar:'world' }, 'foo=hello&');
//=> 'foo=hello&bar=world'

decode('foo=hello&bar=1&bar=2&bar=3&baz=true');
//=> { foo:'hello', bar:[1,2,3], baz:true };

API

qss.encode(params, prefix)

Returns: String

Returns the formatted querystring.

params

Type: Object

The object that contains all query parameter keys & their values.

prefix

Type: String
Default: ''

An optional prefix. The stringified params will be appended to this value, so it must end with your desired joiner; eg ?.

Important: No checks or validations will run on your prefix. Similarly, no character is used to "glue" the query string to your prefix string.

qss.decode(query)

Returns: Object

Returns an Object with decoded keys and values.

Repetitive keys will form an Array of its values. Also, qss will attempt to typecast Boolean and Number values.

query

Type: String

The query string, without its leading ? character.

qss.decode(
  location.search.substring(1) // removes the "?"
);

Benchmarks

Running Node v10.13.0

Encode

qss             x 1,112,341 ops/sec ±0.24% (96 runs sampled)
native          x 5,303,246 ops/sec ±0.76% (95 runs sampled)
querystringify  x   950,501 ops/sec ±0.76% (96 runs sampled)
query-string    x   347,603 ops/sec ±1.05% (92 runs sampled)
qs              x   733,449 ops/sec ±0.62% (97 runs sampled)

Decode

qss             x   443,667 ops/sec ±0.17% (95 runs sampled)
native          x   189,194 ops/sec ±0.44% (94 runs sampled)
querystringify  x   282,169 ops/sec ±0.26% (96 runs sampled)
query-string    x   191,334 ops/sec ±0.71% (95 runs sampled)
qs              x   168,165 ops/sec ±0.41% (93 runs sampled)

License

MIT © Luke Edwards

Versions

Version
2.0.3 Mar 25, 2019