misc(tsc): reorganize and expose external interfaces #4788
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| /** | ||
| * @license Copyright 2018 Google Inc. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| declare namespace LH.Audit { | ||
| export interface ScoringModes { | ||
|
There was a problem hiding this comment. it looks like we can't (at least in a There was a problem hiding this comment. I could be wrong, but I can't make it work. Playground example There was a problem hiding this comment. you mean you're not a fan of this!? 😆 |
||
| NUMERIC: 'numeric'; | ||
| BINARY: 'binary'; | ||
| } | ||
|
|
||
| export type ScoringModeValue = Audit.ScoringModes[keyof Audit.ScoringModes]; | ||
|
|
||
| export interface Meta { | ||
| name: string; | ||
| description: string; | ||
| helpText: string; | ||
| requiredArtifacts: Array<string>; | ||
| failureDescription?: string; | ||
| informative?: boolean; | ||
| manual?: boolean; | ||
| scoreDisplayMode?: Audit.ScoringModeValue; | ||
| } | ||
|
|
||
| export interface Heading { | ||
| key: string; | ||
| itemType: string; | ||
| text: string; | ||
| } | ||
|
|
||
| export interface HeadingsResult { | ||
| results: number; | ||
| headings: Array<Audit.Heading>; | ||
| passes: boolean; | ||
| debugString?: string; | ||
| } | ||
|
|
||
| // TODO: placeholder typedefs until Details are typed | ||
| export interface DetailsRendererDetailsSummary { | ||
| wastedMs?: number; | ||
| wastedBytes?: number; | ||
| } | ||
|
|
||
| // TODO: placeholder typedefs until Details are typed | ||
| export interface DetailsRendererDetailsJSON { | ||
| type: 'table'; | ||
| headings: Array<Audit.Heading>; | ||
| items: Array<{[x: string]: string}>; | ||
| summary: DetailsRendererDetailsSummary; | ||
| } | ||
|
|
||
| // Type returned by Audit.audit(). Only rawValue is required. | ||
| export interface Product { | ||
| rawValue: boolean | number | null; | ||
| displayValue?: string; | ||
| debugString?: string; | ||
| score?: number; | ||
| extendedInfo?: {value: string}; | ||
| notApplicable?: boolean; | ||
| error?: boolean; | ||
| // TODO: define details | ||
| details?: object; | ||
| } | ||
|
|
||
| /* Audit result returned in Lighthouse report. All audits offer a description and score of 0-1 */ | ||
| export interface Result { | ||
| rawValue: boolean | number | null; | ||
| displayValue: string; | ||
| debugString?: string; | ||
| score: number; | ||
| scoreDisplayMode: ScoringModeValue; | ||
| description: string; | ||
| extendedInfo?: {value: string}; | ||
| notApplicable?: boolean; | ||
| error?: boolean; | ||
| name: string; | ||
| helpText?: string; | ||
| informative?: boolean; | ||
| manual?: boolean; | ||
| // TODO: define details | ||
| details?: object; | ||
| } | ||
|
|
||
| export interface Results { | ||
| [metric: string]: Result; | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| /** | ||
| * @license Copyright 2018 Google Inc. All Rights Reserved. | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
| */ | ||
|
|
||
| declare namespace LH.Gatherer { | ||
| export interface PassContext { | ||
| options: object; | ||
| } | ||
|
|
||
| export interface LoadData { | ||
| networkRecords: Array<LH.NetworkRequest>; | ||
| devtoolsLog: Array<void>; | ||
| trace: {trraceEvents: Array<LH.TraceEvent>} | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
global namespaces are merged, so this adds to the
LHnamespace defined inexterns.d.ts