TypeScript definition of protocol

[paulirish]

I've seen a number of developers interested in this.

Currently, there is no officially maintained typescript definition file. We have no immediate plans to begin offering one, but I wanted to point at a great alternative from the community.

I recommend looking at these two projects:
➡️ @krisselden's chrome-debugging-client (see tot.ts)
➡️ @nojvek's chrome-remote-debug-protocol (see crdp.d.ts). (a fork by @roblourens is currently more maintained)

Comment edited March 2018

[JustinRyanH]

I'm working on project to solve this. I'm open to forking off the section relating to Type definitions to it's own repo and collaborating. https://github.com/MajorHard/Enz/tree/proto_types

[krisselden]

https://github.com/krisselden/chrome-debugging-client already works well for automating Chrome, can run headless chrome just fine, just call spawn with additional --headless arg.

@paulirish what's missing? just an example of running a test?

[paulirish]

@krisselden nothings really missing for me! was just sending folks your way for now.

[krisselden]

@paulirish I updated the tests on travis to use headless instead of the x virtual frame buffer https://travis-ci.org/krisselden/chrome-debugging-client and added it to the README example.

[JustinRyanH]

@krisselden I think I've confused chrome-debugg-protocol with your repo. Use the current work as a learning experience.

[auchenberg]

Ping @nojvek @roblourens

[nojvek]

I built a project a while ago that pulls in the protocol.json files from v8 and chrome repos and automatically generate crdp.d.ts files.

The generator lives here: https://github.com/nojvek/chrome-remote-debug-protocol/blob/master/src/protocolToCrdp.ts

@roblourens has a fork that pulls in specific versions of protocol.json and builds version specific crdp.d.ts for use in vscode chrome debugger and node inspector. https://github.com/roblourens/chrome-remote-debug-protocol/blob/master/src/main.ts

crdp.d.ts is promise based and works great with async await: https://github.com/nojvek/chrome-remote-debug-protocol/blob/master/lib/crdp.d.ts

Do note that chrome debugging protocol changes quite a bit, maintaining by hand will quickly get out of hand.

[Bnaya]

It will be very useful to have @types package with the protocol declarations so all of the projects as chrome-remote-interface will depend on to create their own declarations.

What would be the name of such package?

[bbrzoska]

@Bnaya @types packages have to map to actual NPM packages.

[nojvek]

@Bnaya you can `npm install chrome-remote-debug-protocol` which is a pure typings package. https://www.npmjs.com/package/chrome-remote-debug-protocol Since the typings are auto-generated from official google's protocol.json files, they are relatively up-to-date. If you are targeting a specific version of chrome, it's easy to generate typings from that specific version of protocol.json for v8 and blink.

…

On Thu, Aug 10, 2017 at 10:28 AM, Bazyli Brzóska ***@***.***> wrote: @Bnaya <https://github.com/bnaya> @types packages have to map to actual NPM packages. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#18 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AA-JVIm5qebLijKjKz7bymtTEf1Qvk6wks5sWz3OgaJpZM4Nf4bp> .

[paulirish]

This has been contributed to the repo in #90

It's shipped in the npm package devtools-protocol@0.0.547074

Thanks @nojvek !