keyframekit 1.2.0 → 1.2.1

package/docs/docs/reference/interfaces/KeyframesFactory.md

@@ -1,189 +0,0 @@
-[KeyframeKit](../index.md) / KeyframesFactory
-
-# Interface: KeyframesFactory
-
-## Properties
-
-### Error
-
-```ts
-readonly Error: {
-  KeyframesRuleNameTypeError: typeof KeyframesRuleNameTypeError;
-  SourceTypeError: typeof SourceTypeError;
-  StyleSheetImportError: typeof StyleSheetImportError;
-};
-```
-
-#### KeyframesRuleNameTypeError
-
-```ts
-readonly KeyframesRuleNameTypeError: typeof KeyframesRuleNameTypeError;
-```
-
-Thrown if keyframes rule name is not a string.
-
-#### SourceTypeError
-
-```ts
-readonly SourceTypeError: typeof SourceTypeError;
-```
-
-Thrown if source is not a `CSSStyleSheet` or a `StyleSheetList`.
-
-#### StyleSheetImportError
-
-```ts
-readonly StyleSheetImportError: typeof StyleSheetImportError;
-```
-
-Thrown if the stylesheet could not be imported.
-
-## Methods
-
-### getAllStyleSheetKeyframesRules()
-
-```ts
-getAllStyleSheetKeyframesRules(obj: {
-  in: CSSStyleSheetSource;
-}): ParsedKeyframesRules;
-```
-
-Gets all the CSS keyframes rules in a stylesheet or stylesheet list,
-then converts them to Web Animations API keyframes.
-
-#### Parameters
-
-##### obj
-
-###### in
-
-[`CSSStyleSheetSource`](../type-aliases/CSSStyleSheetSource.md)
-
-The style sheet or style sheet list to get keyframes from.
-
-#### Returns
-
-[`ParsedKeyframesRules`](../type-aliases/ParsedKeyframesRules.md)
-
-***
-
-### getDocumentStyleSheetsOnLoad()
-
-```ts
-getDocumentStyleSheetsOnLoad(obj?: {
-  document?: Document;
-}): Promise<StyleSheetList>;
-```
-
-Gets a document's stylesheets when it loads,
-or immediately returns them if it's already loaded.
-
-#### Parameters
-
-##### obj?
-
-###### document?
-
-[`Document`](https://developer.mozilla.org/docs/Web/API/Document) = `window.document`
-
-The document to get stylesheets from.
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`StyleSheetList`](https://developer.mozilla.org/docs/Web/API/StyleSheetList)\>
-
-***
-
-### getStyleSheetKeyframes()
-
-```ts
-getStyleSheetKeyframes(obj: {
-  in: CSSStyleSheetSource;
-  of: string;
-}): ParsedKeyframes | undefined;
-```
-
-Gets a CSS keyframes rule from a stylesheet or stylesheet list,
-then converts it to Web Animations API keyframes.
-
-#### Parameters
-
-##### obj
-
-###### in
-
-[`CSSStyleSheetSource`](../type-aliases/CSSStyleSheetSource.md)
-
-The stylesheet or stylesheet list where the rule resides.
-
-###### of
-
-`string`
-
-The name of the `@keyframes` rule to get keyframes from.
-
-#### Returns
-
-[`ParsedKeyframes`](../classes/ParsedKeyframes.md) \| `undefined`
-
-***
-
-### importStyleSheet()
-
-```ts
-importStyleSheet(url: string): Promise<CSSStyleSheet>;
-```
-
-Imports a stylesheet from a URL.
-
-#### Parameters
-
-##### url
-
-`string`
-
-The URL of the stylesheet to import.
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`CSSStyleSheet`](https://developer.mozilla.org/docs/Web/API/CSSStyleSheet)\>
-
-#### Remarks
-
-Note: `@import` rules won't be resolved in imported stylesheets.  
- See https://github.com/WICG/construct-stylesheets/issues/119#issuecomment-588352418.
-
-***
-
-### parseKeyframesRule()
-
-```ts
-parseKeyframesRule(obj: {
-  rule: CSSKeyframesRule;
-}): ParsedKeyframes;
-```
-
-Converts a CSS keyframes rule to Web Animations API keyframes.
-
-#### Parameters
-
-##### obj
-
-###### rule
-
-[`CSSKeyframesRule`](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule)
-
-The rule to convert.
-
-#### Returns
-
-[`ParsedKeyframes`](../classes/ParsedKeyframes.md)
-
-## See Also
-
-### Referenced Here
-- [CSSStyleSheetSource](../type-aliases/CSSStyleSheetSource.md)
-- [ParsedKeyframes](../classes/ParsedKeyframes.md)
-- [ParsedKeyframesRules](../type-aliases/ParsedKeyframesRules.md)
-### References This
-- [default](../variables/default.md)

package/docs/docs/reference/navigation.json

@@ -1,64 +0,0 @@
-[
-  {
-    "title": "Classes",
-    "children": [
-      {
-        "title": "KeyframeEffectParameters",
-        "kind": 128,
-        "path": "classes/KeyframeEffectParameters.md",
-        "isDeprecated": false
-      },
-      {
-        "title": "ParsedKeyframes",
-        "kind": 128,
-        "path": "classes/ParsedKeyframes.md",
-        "isDeprecated": false
-      }
-    ]
-  },
-  {
-    "title": "Interfaces",
-    "children": [
-      {
-        "title": "KeyframesFactory",
-        "kind": 256,
-        "path": "interfaces/KeyframesFactory.md",
-        "isDeprecated": false
-      }
-    ]
-  },
-  {
-    "title": "Type Aliases",
-    "children": [
-      {
-        "title": "CSSStyleSheetSource",
-        "kind": 2097152,
-        "path": "type-aliases/CSSStyleSheetSource.md",
-        "isDeprecated": false
-      },
-      {
-        "title": "KeyframeArgument",
-        "kind": 2097152,
-        "path": "type-aliases/KeyframeArgument.md",
-        "isDeprecated": false
-      },
-      {
-        "title": "ParsedKeyframesRules",
-        "kind": 2097152,
-        "path": "type-aliases/ParsedKeyframesRules.md",
-        "isDeprecated": false
-      }
-    ]
-  },
-  {
-    "title": "Variables",
-    "children": [
-      {
-        "title": "default",
-        "kind": 32,
-        "path": "variables/default.md",
-        "isDeprecated": false
-      }
-    ]
-  }
-]

package/docs/docs/reference/type-aliases/CSSStyleSheetSource.md

@@ -1,13 +0,0 @@
-[KeyframeKit](../index.md) / CSSStyleSheetSource
-
-# Type Alias: CSSStyleSheetSource
-
-```ts
-type CSSStyleSheetSource = CSSStyleSheet | StyleSheetList;
-```
-
-## See Also
-
-### References This
-- [KeyframesFactory.getAllStyleSheetKeyframesRules](../interfaces/KeyframesFactory.md#getallstylesheetkeyframesrules)
-- [KeyframesFactory.getStyleSheetKeyframes](../interfaces/KeyframesFactory.md#getstylesheetkeyframes)

package/docs/docs/reference/type-aliases/KeyframeArgument.md

@@ -1,15 +0,0 @@
-[KeyframeKit](../index.md) / KeyframeArgument
-
-# Type Alias: KeyframeArgument
-
-```ts
-type KeyframeArgument = Keyframe[] | PropertyIndexedKeyframes;
-```
-
-https://drafts.csswg.org/web-animations-1/#processing-a-keyframes-argument
-
-## See Also
-
-### References This
-- [KeyframeEffectParameters.constructor](../classes/KeyframeEffectParameters.md#constructor)
-- [KeyframeEffectParameters.keyframes](../classes/KeyframeEffectParameters.md#keyframes)

package/docs/docs/reference/type-aliases/ParsedKeyframesRules.md

@@ -1,22 +0,0 @@
-[KeyframeKit](../index.md) / ParsedKeyframesRules
-
-# Type Alias: ParsedKeyframesRules
-
-```ts
-type ParsedKeyframesRules = {
-[ruleName: string]: ParsedKeyframes;
-};
-```
-
-## Index Signature
-
-```ts
-[ruleName: string]: ParsedKeyframes
-```
-
-## See Also
-
-### Referenced Here
-- [ParsedKeyframes](../classes/ParsedKeyframes.md)
-### References This
-- [KeyframesFactory.getAllStyleSheetKeyframesRules](../interfaces/KeyframesFactory.md#getallstylesheetkeyframesrules)

package/docs/docs/reference/variables/default.md

@@ -1,12 +0,0 @@
-[KeyframeKit](../index.md) / default
-
-# Variable: default
-
-```ts
-default: KeyframesFactory;
-```
-
-## See Also
-
-### Referenced Here
-- [KeyframesFactory](../interfaces/KeyframesFactory.md)