@types/simple-icons
Version:
TypeScript definitions for simple-icons
60 lines (49 loc) • 1.72 kB
Markdown
# Installation
> `npm install --save @types/simple-icons`
# Summary
This package contains type definitions for simple-icons (https://simpleicons.org).
# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/simple-icons.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/simple-icons/index.d.ts)
````ts
// Type definitions for simple-icons 5.8
// Project: https://simpleicons.org
// Definitions by: Eric Cornelissen <https://github.com/ericcornelissen>
// Piotr Błażejewicz <https://github.com/peterblazejewicz>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// tslint:disable:no-declare-current-package
declare const icons: Record<string, icons.SimpleIcon> & {
get(name: string): icons.SimpleIcon;
Get(name: string): icons.SimpleIcon;
};
declare namespace icons {
interface SimpleIcon {
title: string;
slug: string;
svg: string;
path: string;
source: string;
hex: string;
guidelines?: string | undefined;
license?:
| {
type: string;
url: string;
}
| undefined;
}
}
declare const icon: icons.SimpleIcon;
declare module 'simple-icons' {
export = icons;
}
declare module 'simple-icons/icons/*' {
export = icon;
}
````
### Additional Details
* Last updated: Sun, 25 Jul 2021 20:01:14 GMT
* Dependencies: none
* Global values: `icon`, `icons`
# Credits
These definitions were written by [Eric Cornelissen](https://github.com/ericcornelissen), and [Piotr Błażejewicz](https://github.com/peterblazejewicz).