# @types/oslicense

> TypeScript definitions for oslicense

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

## Install

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

## Health

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

Positive: has types; no vulnerabilities.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.2.2 |
| Published | 2023-11-07 |
| First published | 2021-10-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | types |

## Links

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

## Recent versions

- 1.2.2 (latest) — 2023-11-07
- 1.2.0 (ts3.7) — 2021-10-11
- 1.2.1 — 2023-10-18

## README

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

# Summary
This package contains type definitions for oslicense (https://github.com/credwards27/oslicense#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/oslicense.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/oslicense/index.d.ts)
````ts
export interface License {
    id: string;
    identifiers: Identifier[];
    keywords: string[];
    links: Link[];
    name: string;
    other_names: OtherName[];
    superseded_by: null | string;
    text: Text[];
}

export interface Identifier {
    identifier: string;
    scheme: string;
}

export interface Link {
    note: string;
    url: string;
}

export interface OtherName {
    name: string;
    note: string;
}

export interface Text {
    media_type: string;
    title: string;
    url: string;
}

/** @async */
export function getLicenses(): Promise<Record<string, string>>;
/** @async */
export function getLicenseData(id: string): Promise<License>;
/** @async */
export function getLicenseText(id: string): Promise<string>;
export function getNearestLicense(): string;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: none

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

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