misc(tsc): reorganize and expose external interfaces #4788
Conversation
brendankenny
requested review from
patrickhulce,
paulirish and
vinamratasingal-zz
as code owners
| * 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 { |
There was a problem hiding this comment.
global namespaces are merged, so this adds to the LH namespace defined in externs.d.ts
| */ | ||
|
|
||
| declare namespace LH.Audit { | ||
| export interface ScoringModes { |
There was a problem hiding this comment.
it looks like we can't (at least in a d.ts file). Since enum defines a type and a value in ts, it expects you to use the value of the enum anywhere the type is expected. So e.g. the values of Audit.SCORING_MODES would have to be LH.Audit.ScoringModes (not just 'numeric' and 'binary', even though that's what those are), but those don't exist in JS if the enum is defined here.
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!?
😆
typings/audit.d.ts
Outdated
| // TODO: placeholder typedefs until Details are typed | ||
| export interface DetailsRendererDetailsSummary { | ||
| wastedMs?: number; | ||
| wastedKb?: number; |
There was a problem hiding this comment.
carryover but this is wastedBytes :)
|
I'll let Paul and Patrick take this review, no opinion from my side. |
moves public interfaces of Audit and Gatherer to
audit.d.tsandgatherer.d.ts. This fixes the problem that typedefs on a class (e.g.Audit) are only local and aren't actually exposed on that module when required elsewhere.Also changes the product of
Audit.audit()toLH.Audit.ProductfromLH.AuditResult, which allowsLH.AuditFullResult(which is actually in the LHR) to just beLH.Audit.Result. Happy to bikeshed on these, though :)Also update to typescript 2.8 (rc) because there's a bug in 2.7 when it wasn't actually checking optional properties when in JS files (not using any new features yet). Can move over to 2.8 when it hits release very soon.