# @types/append-query

> TypeScript definitions for append-query

Latest version **2.0.3** (published 2023-11-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/append-query
pnpm add @types/append-query
yarn add @types/append-query
bun add @types/append-query
```

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.0.3 |
| Published | 2023-11-06 |
| First published | 2019-06-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51430 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/append-query
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/append-query
- npm.io page: https://npm.io/package/@types/append-query

## Recent versions

- 2.0.3 (latest) — 2023-11-06
- 2.0.1 (ts3.6) — 2021-07-07
- 2.0.0 (ts2.0) — 2019-06-08
- 2.0.2 — 2023-10-17

## README

# 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](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/append-query/index.d.ts)
````ts
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: Mon, 06 Nov 2023 22:41:04 GMT
 * Dependencies: none

# Credits
These definitions were written by [Florian Keller](https://github.com/ffflorian).

---
_Source: https://npm.io/package/@types/append-query · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._