Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: adds API docs for fast-colors and fast-animation #3359

Merged
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
wire api-extractor to library
  • Loading branch information
nicholasrice committed Jun 23, 2020
commit a0c8baa8fdf7719d60e88378ec0368c6ce782bd5
16 changes: 16 additions & 0 deletions packages/utilities/fast-animation/api-extractor.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "dist/index.d.ts",
"apiReport": {
"enabled": true,
"reportFolder": "docs",
"reportFileName": "api-report.md"
},
"docModel": {
"enabled": true,
"apiJsonFilePath": "dist/fast-animation.api.json"
},
"dtsRollup": {
"enabled": true
}
}
74 changes: 74 additions & 0 deletions packages/utilities/fast-animation/docs/api-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
## API Report File for "@microsoft/fast-animation"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

// Warning: (ae-forgotten-export) The symbol "Animate" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export class extends Animate {
// Warning: (ae-forgotten-export) The symbol "AnimationMode" needs to be exported by the entry point index.d.ts
//
// (undocumented)
protected mode: AnimationMode;
}

// @public (undocumented)
export class AnimateGroup {
constructor(animations: Array<AnimateTo | AnimateFrom>);
cancel: () => void;
finish: () => void;
onFinish: () => void;
pause: () => void;
play(): void;
reverse(): void;
}

// @public (undocumented)
export class AnimateSequence {
constructor(animations: Array<AnimateTo | AnimateFrom>);
cancel: () => void;
finish: () => void;
onFinish: () => void;
pause: () => void;
play: () => void;
reverse: () => void;
}

// @public (undocumented)
export class extends Animate {
// (undocumented)
protected mode: AnimationMode;
}

// @public (undocumented)
export function cubicBezier(name: string): string;

// @public
export function fadeIn(element: HTMLElement, effectTiming?: EffectTiming): AnimateTo;

// @public
export function fadeOut(element: HTMLElement, effectTiming?: EffectTiming): AnimateTo;

// Warning: (ae-forgotten-export) The symbol "ScrollTrigger" needs to be exported by the entry point index.d.ts
//
// @public
export class ScrollTrigger extends ScrollTrigger_2 {
protected update(): void;
}

// @public
export class ViewEnterTrigger extends ScrollTrigger_2 {
protected update(): void;
}

// @public
export class ViewExitTrigger extends ScrollTrigger_2 {
protected update(): void;
}


// (No @packageDocumentation comment for this package)

```
3 changes: 3 additions & 0 deletions packages/utilities/fast-animation/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@
"build": "tsc -p ./lib/tsconfig.json",
"build:app": "webpack --mode=production",
"coverage": "jest --coverage",
"doc": "api-extractor run --local",
"doc:ci": "api-extractor run",
"prepare": "yarn build",
"prettier": "prettier --config ../../../.prettierrc --write \"**/*.{ts,tsx}\"",
"prettier:diff": "prettier --config ../../../.prettierrc \"**/*.{ts,tsx}\" --list-different",
Expand Down Expand Up @@ -68,6 +70,7 @@
"@babel/core": "^7.0.0",
"@babel/preset-env": "^7.1.0",
"@babel/preset-react": "^7.0.0",
"@microsoft/api-extractor": "^7.7.13",
"@microsoft/eslint-config-fast-dna": "^1.1.3",
"@types/jest": "^25.2.1",
"@types/node": "^7.0.22",
Expand Down
74 changes: 74 additions & 0 deletions packages/utilities/fast-animation/temp/api-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
## API Report File for "@microsoft/fast-animation"

> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).

```ts

// Warning: (ae-forgotten-export) The symbol "Animate" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export class extends Animate {
// Warning: (ae-forgotten-export) The symbol "AnimationMode" needs to be exported by the entry point index.d.ts
//
// (undocumented)
protected mode: AnimationMode;
}

// @public (undocumented)
export class AnimateGroup {
constructor(animations: Array<AnimateTo | AnimateFrom>);
cancel: () => void;
finish: () => void;
onFinish: () => void;
pause: () => void;
play(): void;
reverse(): void;
}

// @public (undocumented)
export class AnimateSequence {
constructor(animations: Array<AnimateTo | AnimateFrom>);
cancel: () => void;
finish: () => void;
onFinish: () => void;
pause: () => void;
play: () => void;
reverse: () => void;
}

// @public (undocumented)
export class extends Animate {
// (undocumented)
protected mode: AnimationMode;
}

// @public (undocumented)
export function cubicBezier(name: string): string;

// @public
export function fadeIn(element: HTMLElement, effectTiming?: EffectTiming): AnimateTo;

// @public
export function fadeOut(element: HTMLElement, effectTiming?: EffectTiming): AnimateTo;

// Warning: (ae-forgotten-export) The symbol "ScrollTrigger" needs to be exported by the entry point index.d.ts
//
// @public
export class ScrollTrigger extends ScrollTrigger_2 {
protected update(): void;
}

// @public
export class ViewEnterTrigger extends ScrollTrigger_2 {
protected update(): void;
}

// @public
export class ViewExitTrigger extends ScrollTrigger_2 {
protected update(): void;
}


// (No @packageDocumentation comment for this package)

```
10 changes: 9 additions & 1 deletion yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -5614,14 +5614,22 @@
dependencies:
"@types/react" "*"

"@types/react@*", "@types/react@^16.3.0", "@types/react@^16.4.18", "@types/react@^16.7.17", "@types/react@^16.8.0", "@types/react@^16.8.19", "@types/react@^16.9.17":
"@types/react@*", "@types/react@^16.3.0", "@types/react@^16.4.18", "@types/react@^16.7.17", "@types/react@^16.8.0", "@types/react@^16.8.19":
version "16.9.11"
resolved "https://registry.yarnpkg.com/@types/react/-/react-16.9.11.tgz#70e0b7ad79058a7842f25ccf2999807076ada120"
integrity sha512-UBT4GZ3PokTXSWmdgC/GeCGEJXE5ofWyibCcecRLUVN2ZBpXQGVgQGtG2foS7CrTKFKlQVVswLvf7Js6XA/CVQ==
dependencies:
"@types/prop-types" "*"
csstype "^2.2.0"

"@types/react@^16.9.17":
version "16.9.38"
resolved "https://registry.yarnpkg.com/@types/react/-/react-16.9.38.tgz#868405dace93a4095d3e054f4c4a1de7a1ac0680"
integrity sha512-pHAeZbjjNRa/hxyNuLrvbxhhnKyKNiLC6I5fRF2Zr/t/S6zS41MiyzH4+c+1I9vVfvuRt1VS2Lodjr4ZWnxrdA==
dependencies:
"@types/prop-types" "*"
csstype "^2.2.0"

"@types/resolve@0.0.8":
version "0.0.8"
resolved "https://registry.yarnpkg.com/@types/resolve/-/resolve-0.0.8.tgz#f26074d238e02659e323ce1a13d041eee280e194"
Expand Down