# @types/shimmer

> TypeScript definitions for shimmer

Latest version **1.2.0** (published 2024-07-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/shimmer
pnpm add @types/shimmer
yarn add @types/shimmer
bun add @types/shimmer
```

## 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 | 1.2.0 |
| Published | 2024-07-08 |
| First published | 2017-12-06 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 3.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51445 |
| Maintainers | types |

## Links

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

## Recent versions

- 1.2.0 (latest) — 2024-07-08
- 1.0.5 (ts4.6) — 2023-11-07
- 1.0.2 (ts4.4) — 2021-07-06
- 1.0.1 (ts3.5) — 2018-03-01
- 1.0.4 — 2023-10-18
- 1.0.3 — 2023-09-25
- 1.0.0 — 2017-12-06

## README

# Installation
> `npm install --save @types/shimmer`

# Summary
This package contains type definitions for shimmer (https://github.com/othiym23/shimmer).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shimmer.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/shimmer/index.d.ts)
````ts
declare const shimmer: {
    (options: { logger?(msg: string): void }): void;
    wrap<Nodule extends object, FieldName extends keyof Nodule>(
        nodule: Nodule,
        name: FieldName,
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ): void;
    massWrap<Nodule extends object, FieldName extends keyof Nodule>(
        nodules: Nodule[],
        names: FieldName[],
        wrapper: (original: Nodule[FieldName]) => Nodule[FieldName],
    ): void;
    unwrap<Nodule extends object>(
        nodule: Nodule,
        name: keyof Nodule,
    ): void;
    massUnwrap<Nodule extends object>(
        nodules: Nodule[],
        names: Array<keyof Nodule>,
    ): void;
};

export = shimmer;

````

### Additional Details
 * Last updated: Mon, 08 Jul 2024 08:09:26 GMT
 * Dependencies: none

# Credits
These definitions were written by [Kelvin Jin](https://github.com/kjin).

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