# @types/ref-union

> TypeScript definitions for ref-union

Latest version **0.0.32** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/ref-union
pnpm add @types/ref-union
yarn add @types/ref-union
bun add @types/ref-union
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.32 |
| Published | 2023-11-07 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

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

## Dependencies (1)

- [@types/ref](https://npm.io/package/@types/ref.md) *

## Recent versions

- 0.0.32 (latest) — 2023-11-07
- 0.0.29 (ts4.4) — 2023-04-29
- 0.0.28 (ts2.9) — 2016-09-19
- 0.0.31 — 2023-10-18
- 0.0.30 — 2023-09-27
- 0.0.27 — 2016-07-14
- 0.0.26-alpha — 2016-07-08
- 0.0.25-alpha — 2016-07-04
- 0.0.24-alpha — 2016-07-02
- 0.0.23-alpha — 2016-07-01
- 0.0.22-alpha — 2016-07-01
- 0.0.21-alpha — 2016-05-25
- 0.0.20-alpha — 2016-05-20
- 0.0.15-alpha — 2016-05-19
- 0.0.14-alpha — 2016-05-17

## README

# Installation
> `npm install --save @types/ref-union`

# Summary
This package contains type definitions for ref-union (https://github.com/TooTallNate/ref-union).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ref-union.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/ref-union/index.d.ts)
````ts
import ref = require("ref");

/**
 * This is the `constructor` of the Struct type that gets returned.
 *
 * Invoke it with `new` to create a new Buffer instance backing the union.
 * Pass it an existing Buffer instance to use that as the backing buffer.
 * Pass in an Object containing the union fields to auto-populate the
 * union with the data.
 */
interface UnionType extends ref.Type {
    /** Pass it an existing Buffer instance to use that as the backing buffer. */
    new(arg: Buffer, data?: {}): any;
    new(data?: {}): any;
    /** Pass it an existing Buffer instance to use that as the backing buffer. */
    (arg: Buffer, data?: {}): any;
    (data?: {}): any;

    fields: { [key: string]: { type: ref.Type } };

    /**
     * Adds a new field to the union instance with the given name and type.
     * Note that this function will throw an Error if any instances of the union
     * type have already been created, therefore this function must be called at the
     * beginning, before any instances are created.
     */
    defineProperty(name: string, type: ref.Type): void;

    /**
     * Adds a new field to the union instance with the given name and type.
     * Note that this function will throw an Error if any instances of the union
     * type have already been created, therefore this function must be called at the
     * beginning, before any instances are created.
     */
    defineProperty(name: string, type: string): void;

    /**
     * Custom for union type instances.
     * @override
     */
    toString(): string;
}

/** The union type meta-constructor. */
declare var UnionType: {
    new(fields?: {}): UnionType;
    new(fields?: any[]): UnionType;
    (fields?: {}): UnionType;
    (fields?: any[]): UnionType;
};

export = UnionType;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 15:11:36 GMT
 * Dependencies: [@types/ref](https://npmjs.com/package/@types/ref)

# Credits
These definitions were written by [Paul Loyd](https://github.com/loyd).

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