2.0.3 • Published 6 months ago
@types/append-query v2.0.3
Installation
npm install --save @types/append-query
Summary
This package contains type definitions for append-query (https://github.com/lakenen/node-append-query).
Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/append-query.
index.d.ts
// Type definitions for append-query 2.0
// Project: https://github.com/lakenen/node-append-query
// Definitions by: Florian Keller <https://github.com/ffflorian>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace appendQuery {
interface Query {
[index: string]: string | null;
}
interface Options {
/**
* whether or not to encode appended passed params using `encodeURIComponent`.
* Default: `true`.
*/
encodeComponents?: boolean | undefined;
/**
* whether or not to remove params for `null` properties in the query object.
* Default: `false` (properties will be preserved with no value).
*/
removeNull?: boolean | undefined;
}
}
/**
* @param url a string URL to append to
* @param query a string or object containing query params to append
*/
declare function appendQuery(url: string, query: string | appendQuery.Query, options?: appendQuery.Options): string;
export = appendQuery;
Additional Details
- Last updated: Wed, 07 Jul 2021 21:44:27 GMT
- Dependencies: none
- Global values: none
Credits
These definitions were written by Florian Keller.