@types/webidl-conversions

What is @types/webidl-conversions?

The @types/webidl-conversions package provides TypeScript type definitions for the webidl-conversions library, which is a utility for converting JavaScript values to WebIDL types as specified in the WebIDL specification. This is particularly useful when working with Web APIs in a type-safe manner, ensuring that values passed to and from Web APIs conform to the expected types.

What are @types/webidl-conversions's main functionalities?

Converting basic types

This feature demonstrates how to convert basic JavaScript types to WebIDL types, such as DOMString and boolean. The context option provides additional information for error messages.

import * as WebIDL from 'webidl-conversions';
let myString = WebIDL.DOMString('123', { context: 'Argument 1' });
let myBoolean = WebIDL.boolean('true', { context: 'Argument 2' });

Converting complex types

This feature shows the conversion of more complex JavaScript types to WebIDL types, like object and byte. It illustrates the flexibility of the library in handling various types.

import * as WebIDL from 'webidl-conversions';
let myObject = WebIDL.object({ a: 1, b: 2 }, { context: 'Argument 1' });
let myByte = WebIDL.byte('123', { context: 'Argument 2' });

Other packages similar to @types/webidl-conversions

webidl2js

webidl2js is a package that translates WebIDL into JavaScript implementations. Unlike @types/webidl-conversions, which focuses on type conversions, webidl2js deals with generating JavaScript bindings for WebIDL interfaces, making it more suited for implementing web platform APIs in JavaScript.

README

Installation

npm install --save @types/webidl-conversions

Summary

This package contains type definitions for webidl-conversions (https://github.com/jsdom/webidl-conversions#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/webidl-conversions.

Additional Details

• Last updated: Tue, 07 Nov 2023 15:11:36 GMT
• Dependencies: none

Credits

These definitions were written by ExE Boss, and BendingBender.