Skip to content

Commit

Permalink
fix api extractor
Browse files Browse the repository at this point in the history
  • Loading branch information
jackfranklin committed Jul 14, 2020
1 parent 7468ce9 commit 7250519
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 5 deletions.
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Expand Up @@ -119,6 +119,10 @@ The main entry point for the Node module Puppeteer is `cjs-entry.js`. This impor

We also maintain `test/tsconfig.test.json`. This is **only used to compile the unit test `*.spec.ts` files**. When the tests are run, we first compile Puppeteer as normal before running the unit tests **against the compiled output**. Doing this lets the test run against the compiled code we ship to users so it gives us more confidence in our compiled output being correct.

### Root `tsconfig.json`

The root `tsconfig.json` exists for the API Extractor; it has to find a `tsconfig.json` in the project's root directory. It is _not_ used for anything else.


## API guidelines

Expand Down
2 changes: 1 addition & 1 deletion api-extractor.json
@@ -1,6 +1,6 @@
{
"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
"mainEntryPointFilePath": "<projectFolder>/lib/cjs/api-docs-entry.d.ts",
"mainEntryPointFilePath": "<projectFolder>/lib/cjs/puppeteer/api-docs-entry.d.ts",
"bundledPackages": [ "devtools-protocol" ],

"apiReport": {
Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.md
Expand Up @@ -85,7 +85,7 @@

| Namespace | Description |
| --- | --- |
| [Protocol](./puppeteer.protocol.md) | \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* |
| [Protocol](./puppeteer.protocol.md) | The Chrome DevTools protocol. |

## Variables

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.protocol.css.cssmedia.md
Expand Up @@ -18,7 +18,7 @@ export interface CSSMedia
| --- | --- | --- |
| [mediaList](./puppeteer.protocol.css.cssmedia.medialist.md) | [MediaQuery](./puppeteer.protocol.css.mediaquery.md)<!-- -->\[\] | Array of media queries. |
| [range](./puppeteer.protocol.css.cssmedia.range.md) | [SourceRange](./puppeteer.protocol.css.sourcerange.md) | The associated rule (<!-- -->@<!-- -->media or @<!-- -->import) header range in the enclosing stylesheet (if available). |
| [source](./puppeteer.protocol.css.cssmedia.source.md) | ('mediaRule' \| 'importRule' \| 'linkedSheet' \| 'inlineSheet') | Source of the media query: "mediaRule" if specified by a rule, "importRule" if specified by an rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag. |
| [source](./puppeteer.protocol.css.cssmedia.source.md) | ('mediaRule' \| 'importRule' \| 'linkedSheet' \| 'inlineSheet') | Source of the media query: "mediaRule" if specified by a <code>@media</code> rule, "importRule" if specified by an <code>@import</code> rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag. |
| [sourceURL](./puppeteer.protocol.css.cssmedia.sourceurl.md) | string | URL of the document containing the media query description. |
| [styleSheetId](./puppeteer.protocol.css.cssmedia.stylesheetid.md) | [StyleSheetId](./puppeteer.protocol.css.stylesheetid.md) | Identifier of the stylesheet containing this object (if exists). |
| [text](./puppeteer.protocol.css.cssmedia.text.md) | string | Media query text. |
Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.protocol.css.cssmedia.source.md
Expand Up @@ -4,7 +4,7 @@

## Protocol.CSS.CSSMedia.source property

Source of the media query: "mediaRule" if specified by a rule, "importRule" if specified by an rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag.
Source of the media query: "mediaRule" if specified by a `@media` rule, "importRule" if specified by an `@import` rule, "linkedSheet" if specified by a "media" attribute in a linked stylesheet's LINK tag, "inlineSheet" if specified by a "media" attribute in an inline stylesheet's STYLE tag.

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion new-docs/puppeteer.protocol.md
Expand Up @@ -4,7 +4,7 @@

## Protocol namespace

\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\* Auto-generated by protocol-dts-generator.ts, do not edit manually. \* \*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*\*
The Chrome DevTools protocol.

<b>Signature:</b>

Expand Down
11 changes: 11 additions & 0 deletions tsconfig.json
@@ -0,0 +1,11 @@
/**
* This configuration only exists for the API Extractor tool. See the details in
* CONTRIBUTING.md that describes our TypeScript setup.
*/
{
"extends": "./tsconfig.base.json",
"compilerOptions": {
"noEmit": true
},
"include": ["src"]
}

0 comments on commit 7250519

Please sign in to comment.