thunderstrike/puppeteer
thunderstrike/puppeteer
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

chore: use Node's promisify function (#5748)

Browse Source 
Node's promisify function and the TS types for it give much better type understanding when wrapping a function in `promisify`. This change means we don't maintain our own implementation and our own (sub-par) types and rather lean on the tested and thorough @types/node version instead.
This commit is contained in:
Jack Franklin 2020-04-27 11:51:59 +01:00 committed by GitHub
parent 1b9d9e9cc0
commit 5e2a029e44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/helper.ts
View File

@ -13,14 +13,11 @@
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
import Errors = require('./Errors'); import {TimeoutError} from './Errors';
import * as debug from 'debug';
import debug = require('debug'); import * as fs from 'fs';
import fs = require('fs');
import promisify = require('./promisify');
import {CDPSession} from './Connection'; import {CDPSession} from './Connection';
import {promisify} from 'util';
const {TimeoutError} = Errors;
const openAsync = promisify(fs.open); const openAsync = promisify(fs.open);
const writeAsync = promisify(fs.write); const writeAsync = promisify(fs.write);

51
src/promisify.ts
View File

@ -1,51 +0,0 @@
/**
* Copyright 2020 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.
*/
/* This is a poor typed implementation of promisify. It would be much
* nicer to use util.promisfy from Node but we need it to work in the
* browser as we bundle via Browserify and Browserify doesn't seem to
* bundle the util module when it does. The long term goal for our web
* bundle isn't to use Browserify but something more modern (probably
* Rollup?) and so rather than delay the TypeScript migration with a big
* tangent around web bundling we'll use this for now and loop back once
* src/ is 100% TypeScript.
*
* TODO (jacktfranklin@) swap this for util.promisify so we get much
* better type support from TypeScript
*/
type CallbackFunc = (...args: any[]) => void;
type PromisifiedFunc = (...args: any[]) => Promise<any>;
function promisify<ResultType extends any>(func: CallbackFunc): PromisifiedFunc {
function promisified(...args): Promise<ResultType | ResultType[]> {
return new Promise((resolve, reject) => {
function callback(err: Error | null, ...result: ResultType[]): void {
if (err)
return reject(err);
if (result.length === 1)
return resolve(result[0]);
return resolve(result);
}
func.call(null, ...args, callback);
});
}
return promisified;
}
export = promisify;