UNPKG

654 BTypeScriptView Raw
1/**
2 * The license for a Simple Icon.
3 *
4 * @see {@link https://github.com/simple-icons/simple-icons/blob/develop/CONTRIBUTING.md#optional-data Optional Data}
5 */
6export type License = SPDXLicense | CustomLicense;
7
8// eslint-disable-next-line @typescript-eslint/naming-convention
9export type SPDXLicense = {
10 type: string;
11 url: string;
12};
13
14export type CustomLicense = {
15 type: 'custom';
16 url: string;
17};
18
19/**
20 * The data for a Simple Icon as is exported by the npm package.
21 */
22export type SimpleIcon = {
23 title: string;
24 slug: string;
25 svg: string;
26 path: string;
27 source: string;
28 hex: string;
29 guidelines?: string;
30 license?: License;
31};