chore: update docs

This commit is contained in:
Simon Chan 2022-04-03 13:14:05 +08:00
parent 8a521c8d93
commit 82f5a90838
No known key found for this signature in database
GPG key ID: A8B69F750B9BCEDD
6 changed files with 62 additions and 52 deletions

View file

@ -19,14 +19,14 @@ export const VERSION_OMIT_CHECKSUM = 0x01000001;
export class Adb {
/**
* It's possible to call `authenticate` multiple times on a single connection,
* every time the device receives a `CNXN` packet it will reset its internal state,
* and begin authentication again.
* every time the device receives a `CNXN` packet, it resets its internal state,
* and starts a new authentication process.
*/
public static async authenticate(
connection: ReadableWritablePair<AdbPacketCore, AdbPacketCore>,
credentialStore: AdbCredentialStore,
authenticators = AdbDefaultAuthenticators,
) {
): Promise<Adb> {
let version = 0x01000001;
let maxPayloadSize = 0x100000;