# @types/graphlib-dot

> TypeScript definitions for graphlib-dot

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

## Install

```sh
npm install @types/graphlib-dot
pnpm add @types/graphlib-dot
yarn add @types/graphlib-dot
bun add @types/graphlib-dot
```

## 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; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.6.4 |
| Published | 2023-11-07 |
| First published | 2018-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51443 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 0.6.4 (latest) — 2023-11-07
- 0.6.1 (ts2.0) — 2019-02-13
- 0.6.3 — 2023-10-18
- 0.6.2 — 2023-09-20
- 0.6.0 — 2018-11-01

## README

# Installation
> `npm install --save @types/graphlib-dot`

# Summary
This package contains type definitions for graphlib-dot (https://github.com/dagrejs/graphlib-dot).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/graphlib-dot.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/graphlib-dot/index.d.ts)
````ts
import { Graph } from "graphlib";

/**
 * Reads a single DOT graph from the str and returns it a Graph representation.
 * @param str a string in the DOT language representing a graph
 */
export function read(str: string): Graph;

/**
 * Parses one or more DOT graphs from str in a manner similar to that used by parse for individual graphs.
 * @param str a string in the DOT language representing one or more graphs
 */
export function readMany(str: string): Graph[];

/**
 * Writes a String representation of the given graph in the DOT language.
 * @param g a graphlib Graph object
 */
export function write(g: Graph): string;

/**
 * Contains the version of the graphlib library used by graphlib-dot.
 */
export const graphlib: any;

declare global {
    namespace graphlibDot {
        /**
         * Reads a single DOT graph from the str and returns it a Graph representation.
         * @param str a string in the DOT language representing a graph
         */
        function read(str: string): Graph;

        /**
         * Parses one or more DOT graphs from str in a manner similar to that used by parse for individual graphs.
         * @param str a string in the DOT language representing one or more graphs
         */
        function readMany(str: string): Graph[];

        /**
         * Writes a String representation of the given graph in the DOT language.
         * @param g a graphlib Graph object
         */
        function write(g: Graph): string;

        /**
         * Contains the version of the graphlib library used by graphlib-dot.
         */
        const graphlib: any;
    }
}

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [@types/graphlib](https://npmjs.com/package/@types/graphlib)

# Credits
These definitions were written by [Dom Parfitt](https://github.com/DomParfitt).

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