keyframekit 1.0.7 → 1.0.9

package/docs/docs/reference/classes/KeyframeEffectParameters.md

@@ -1,95 +1,95 @@
-[KeyframeKit](../index.md) / KeyframeEffectParameters
-
-# Class: KeyframeEffectParameters
-
-https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
-
-## Constructors
-
-### Constructor
-
-```ts
-new KeyframeEffectParameters(obj: {
-  keyframes: KeyframeArgument;
-  options?: number | KeyframeEffectOptions;
-}): KeyframeEffectParameters;
-```
-
-#### Parameters
-
-##### obj
-
-###### keyframes
-
-[`KeyframeArgument`](../type-aliases/KeyframeArgument.md)
-
-[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)
-
-###### options?
-
-`number` \| `KeyframeEffectOptions` = `{}`
-
-[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
-
-#### Returns
-
-`KeyframeEffectParameters`
-
-## Properties
-
-### keyframes
-
-```ts
-keyframes: KeyframeArgument;
-```
-
-***
-
-### options
-
-```ts
-options: KeyframeEffectOptions;
-```
-
-## Methods
-
-### toAnimation()
-
-```ts
-toAnimation(obj: {
-  options?: number | KeyframeEffectOptions;
-  target: Element | null;
-  timeline?: AnimationTimeline;
-}): Animation;
-```
-
-#### Parameters
-
-##### obj
-
-###### options?
-
-`number` \| `KeyframeEffectOptions` = `{}`
-
-Additional keyframe effect options. Can override existing keys.
-[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
-
-###### target
-
-[`Element`](https://developer.mozilla.org/docs/Web/API/Element) \| `null`
-
-An element to attach the animation to.
-
-###### timeline?
-
-[`AnimationTimeline`](https://developer.mozilla.org/docs/Web/API/AnimationTimeline) = `document.timeline`
-
-#### Returns
-
-[`Animation`](https://developer.mozilla.org/docs/Web/API/Animation)
-
-#### See
-
-Specifications:
-- https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
-- https://drafts.csswg.org/web-animations-1/#the-animation-interface
+[KeyframeKit](../index.md) / KeyframeEffectParameters
+
+# Class: KeyframeEffectParameters
+
+https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
+
+## Constructors
+
+### Constructor
+
+```ts
+new KeyframeEffectParameters(obj: {
+  keyframes: KeyframeArgument;
+  options?: number | KeyframeEffectOptions;
+}): KeyframeEffectParameters;
+```
+
+#### Parameters
+
+##### obj
+
+###### keyframes
+
+[`KeyframeArgument`](../type-aliases/KeyframeArgument.md)
+
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/Web_Animations_API/Keyframe_Formats)
+
+###### options?
+
+`number` \| `KeyframeEffectOptions` = `{}`
+
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+
+#### Returns
+
+`KeyframeEffectParameters`
+
+## Properties
+
+### keyframes
+
+```ts
+keyframes: KeyframeArgument;
+```
+
+***
+
+### options
+
+```ts
+options: KeyframeEffectOptions;
+```
+
+## Methods
+
+### toAnimation()
+
+```ts
+toAnimation(obj: {
+  options?: number | KeyframeEffectOptions;
+  target: Element | null;
+  timeline?: AnimationTimeline;
+}): Animation;
+```
+
+#### Parameters
+
+##### obj
+
+###### options?
+
+`number` \| `KeyframeEffectOptions` = `{}`
+
+Additional keyframe effect options. Can override existing keys.
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+
+###### target
+
+[`Element`](https://developer.mozilla.org/docs/Web/API/Element) \| `null`
+
+An element to attach the animation to.
+
+###### timeline?
+
+[`AnimationTimeline`](https://developer.mozilla.org/docs/Web/API/AnimationTimeline) = `document.timeline`
+
+#### Returns
+
+[`Animation`](https://developer.mozilla.org/docs/Web/API/Animation)
+
+#### See
+
+Specifications:
+- https://drafts.csswg.org/web-animations-1/#the-keyframeeffect-interface
+- https://drafts.csswg.org/web-animations-1/#the-animation-interface

package/docs/docs/reference/classes/ParsedKeyframes.md

@@ -1,49 +1,49 @@
-[KeyframeKit](../index.md) / ParsedKeyframes
-
-# Class: ParsedKeyframes
-
-## Constructors
-
-### Constructor
-
-```ts
-new ParsedKeyframes(keyframes: Keyframe[]): ParsedKeyframes;
-```
-
-#### Parameters
-
-##### keyframes
-
-`Keyframe`[]
-
-#### Returns
-
-`ParsedKeyframes`
-
-## Properties
-
-### keyframes
-
-```ts
-keyframes: Keyframe[];
-```
-
-## Methods
-
-### toKeyframeEffect()
-
-```ts
-toKeyframeEffect(options: number | KeyframeEffectOptions | null): KeyframeEffectParameters;
-```
-
-#### Parameters
-
-##### options
-
-[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
-
-`number` | `KeyframeEffectOptions` | `null`
-
-#### Returns
-
-[`KeyframeEffectParameters`](KeyframeEffectParameters.md)
+[KeyframeKit](../index.md) / ParsedKeyframes
+
+# Class: ParsedKeyframes
+
+## Constructors
+
+### Constructor
+
+```ts
+new ParsedKeyframes(keyframes: Keyframe[]): ParsedKeyframes;
+```
+
+#### Parameters
+
+##### keyframes
+
+`Keyframe`[]
+
+#### Returns
+
+`ParsedKeyframes`
+
+## Properties
+
+### keyframes
+
+```ts
+keyframes: Keyframe[];
+```
+
+## Methods
+
+### toKeyframeEffect()
+
+```ts
+toKeyframeEffect(options: number | KeyframeEffectOptions | null): KeyframeEffectParameters;
+```
+
+#### Parameters
+
+##### options
+
+[MDN Reference](https://developer.mozilla.org/en-US/docs/Web/API/KeyframeEffect/KeyframeEffect#options)
+
+`number` | `KeyframeEffectOptions` | `null`
+
+#### Returns
+
+[`KeyframeEffectParameters`](KeyframeEffectParameters.md)

package/docs/docs/reference/index.md

@@ -1,20 +1,20 @@
-# KeyframeKit
-
-## Classes
-
-- [KeyframeEffectParameters](classes/KeyframeEffectParameters.md)
-- [ParsedKeyframes](classes/ParsedKeyframes.md)
-
-## Interfaces
-
-- [KeyframesFactory](interfaces/KeyframesFactory.md)
-
-## Type Aliases
-
-- [KeyframeArgument](type-aliases/KeyframeArgument.md)
-- [KeyframesFactorySource](type-aliases/KeyframesFactorySource.md)
-- [ParsedKeyframesRules](type-aliases/ParsedKeyframesRules.md)
-
-## Variables
-
-- [default](variables/default.md)
+# KeyframeKit
+
+## Classes
+
+- [KeyframeEffectParameters](classes/KeyframeEffectParameters.md)
+- [ParsedKeyframes](classes/ParsedKeyframes.md)
+
+## Interfaces
+
+- [KeyframesFactory](interfaces/KeyframesFactory.md)
+
+## Type Aliases
+
+- [KeyframeArgument](type-aliases/KeyframeArgument.md)
+- [KeyframesFactorySource](type-aliases/KeyframesFactorySource.md)
+- [ParsedKeyframesRules](type-aliases/ParsedKeyframesRules.md)
+
+## Variables
+
+- [default](variables/default.md)

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

@@ -1,151 +1,151 @@
-[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;
-```
-
-#### SourceTypeError
-
-```ts
-readonly SourceTypeError: typeof SourceTypeError;
-```
-
-#### StyleSheetImportError
-
-```ts
-readonly StyleSheetImportError: typeof StyleSheetImportError;
-```
-
-## Methods
-
-### getAllStyleSheetKeyframesRules()
-
-```ts
-getAllStyleSheetKeyframesRules(obj: {
-  in: KeyframesFactorySource;
-}): ParsedKeyframesRules;
-```
-
-#### Parameters
-
-##### obj
-
-###### in
-
-[`KeyframesFactorySource`](../type-aliases/KeyframesFactorySource.md)
-
-#### Returns
-
-[`ParsedKeyframesRules`](../type-aliases/ParsedKeyframesRules.md)
-
-***
-
-### getDocumentStyleSheetsOnLoad()
-
-```ts
-getDocumentStyleSheetsOnLoad(obj?: {
-  document?: Document;
-}): Promise<StyleSheetList>;
-```
-
-#### Parameters
-
-##### obj?
-
-###### document?
-
-[`Document`](https://developer.mozilla.org/docs/Web/API/Document) = `window.document`
-
-#### 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: KeyframesFactorySource;
-  of: string;
-}): ParsedKeyframes | undefined;
-```
-
-#### Parameters
-
-##### obj
-
-###### in
-
-[`KeyframesFactorySource`](../type-aliases/KeyframesFactorySource.md)
-
-###### 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>;
-```
-
-#### Parameters
-
-##### url
-
-`string`
-
-#### 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;
-```
-
-#### Parameters
-
-##### obj
-
-###### rule
-
-[`CSSKeyframesRule`](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule)
-
-#### Returns
-
-[`ParsedKeyframes`](../classes/ParsedKeyframes.md)
+[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;
+```
+
+#### SourceTypeError
+
+```ts
+readonly SourceTypeError: typeof SourceTypeError;
+```
+
+#### StyleSheetImportError
+
+```ts
+readonly StyleSheetImportError: typeof StyleSheetImportError;
+```
+
+## Methods
+
+### getAllStyleSheetKeyframesRules()
+
+```ts
+getAllStyleSheetKeyframesRules(obj: {
+  in: KeyframesFactorySource;
+}): ParsedKeyframesRules;
+```
+
+#### Parameters
+
+##### obj
+
+###### in
+
+[`KeyframesFactorySource`](../type-aliases/KeyframesFactorySource.md)
+
+#### Returns
+
+[`ParsedKeyframesRules`](../type-aliases/ParsedKeyframesRules.md)
+
+***
+
+### getDocumentStyleSheetsOnLoad()
+
+```ts
+getDocumentStyleSheetsOnLoad(obj?: {
+  document?: Document;
+}): Promise<StyleSheetList>;
+```
+
+#### Parameters
+
+##### obj?
+
+###### document?
+
+[`Document`](https://developer.mozilla.org/docs/Web/API/Document) = `window.document`
+
+#### 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: KeyframesFactorySource;
+  of: string;
+}): ParsedKeyframes | undefined;
+```
+
+#### Parameters
+
+##### obj
+
+###### in
+
+[`KeyframesFactorySource`](../type-aliases/KeyframesFactorySource.md)
+
+###### 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>;
+```
+
+#### Parameters
+
+##### url
+
+`string`
+
+#### 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;
+```
+
+#### Parameters
+
+##### obj
+
+###### rule
+
+[`CSSKeyframesRule`](https://developer.mozilla.org/docs/Web/API/CSSKeyframesRule)
+
+#### Returns
+
+[`ParsedKeyframes`](../classes/ParsedKeyframes.md)