@iconify/types
Advanced tools
Comparing version 1.0.4 to 1.0.5
{ | ||
"name": "@iconify/types", | ||
"description": "Types for Iconify data", | ||
"version": "1.0.4", | ||
"version": "1.0.5", | ||
"author": "Vjacheslav Trushkin", | ||
@@ -9,3 +9,5 @@ "license": "(Apache-2.0 OR GPL-2.0)", | ||
"types": "./types.ts", | ||
"scripts": {}, | ||
"scripts": { | ||
"test": "tsc --noEmit --strict --typeRoots '[]' types.ts" | ||
}, | ||
"bugs": "https://github.com/iconify/iconify/issues", | ||
@@ -18,4 +20,6 @@ "homepage": "https://github.com/iconify/iconify", | ||
}, | ||
"devDependencies": {}, | ||
"devDependencies": { | ||
"typescript": "^4.0.5" | ||
}, | ||
"dependencies": {} | ||
} |
26
types.ts
@@ -57,6 +57,3 @@ /** | ||
IconifyTransformations { | ||
// True if icon is hidden. | ||
// Used in icon sets to keep icons that no longer exist, but should still be accessible | ||
// from API, preventing websites from breaking when icon is removed by developer. | ||
hidden?: boolean; | ||
// | ||
} | ||
@@ -88,7 +85,20 @@ | ||
/** | ||
* Icon with optional parameters that are provided by API and affect only search | ||
*/ | ||
interface APIIconAttributes { | ||
// True if icon is hidden. | ||
// Used in icon sets to keep icons that no longer exist, but should still be accessible | ||
// from API, preventing websites from breaking when icon is removed by developer. | ||
hidden?: boolean; | ||
} | ||
export interface ExtendedIconifyIcon extends IconifyIcon, APIIconAttributes {} | ||
export interface ExtendedIconifyAlias extends IconifyAlias, APIIconAttributes {} | ||
/** | ||
* "icons" field of JSON file. | ||
*/ | ||
export interface IconifyIcons { | ||
// Index is name of icon, without prefix. Value is IconifyIcon object. | ||
[index: string]: IconifyIcon; | ||
// Index is name of icon, without prefix. Value is ExtendedIconifyIcon object. | ||
[index: string]: ExtendedIconifyIcon; | ||
} | ||
@@ -100,4 +110,4 @@ | ||
export interface IconifyAliases { | ||
// Index is name of icon, without prefix. Value is IconifyAlias object. | ||
[index: string]: IconifyAlias; | ||
// Index is name of icon, without prefix. Value is ExtendedIconifyAlias object. | ||
[index: string]: ExtendedIconifyAlias; | ||
} | ||
@@ -104,0 +114,0 @@ |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
48738
231
1