Type Definition Importer for Scala.js

Github Web App by @exoego on exoego.net under the Scala License

Speifies how to convert field-only interfaces.

Such interfaces are usually used as parameter of function, so users will want to construct and pass it to function.

Given "Abstract" "Implemented"

Given	"Abstract"	"Implemented"
`interface Foo { a: string; b: number; }`	`trait Foo extends js.Object { var a: String var b: Double }` Field-only interfaces will be abstract trait.	`@js.native trait Foo extends js.Object { var a: String = js.native var b: Double = js.native }` Field-only interfaces will be js.native-implemented trait. They can not be directly constructed, so may be inconvenient.

interface Foo {
  a: string;
  b: number;
}

trait Foo extends js.Object {
  var a: String
  var b: Double
}

Field-only interfaces will be abstract trait.

@js.native
trait Foo extends js.Object {
  var a: String = js.native
  var b: Double = js.native
}

Field-only interfaces will be js.native-implemented trait. They can not be directly constructed, so may be inconvenient.

Abstract (recommended)

Native-implemented

Specifies whether factory methods for field-only trait are added or not.

Given "Do not generate" "Generate" "Generate with no trailing comma"

Given	"Do not generate"	"Generate"	"Generate with no trailing comma"
`interface Foo { a: string; b: number; }`	`// no factory generated` This can reduce size of type definition.	`object Foo { def apply( a: String, b: Double, ): Foo = { val _obj$ = js.Dynamic.literal( "a" -> a.asInstanceOf[js.Any], "b" -> b.asInstanceOf[js.Any], ) _obj$.asInstanceOf[Foo] } }` These methods are useful if traits are generated as @js.native marked trait, since such trait can not be directly constructed.	`object Foo { def apply( a: String, b: Double ): Foo = { val _obj$ = js.Dynamic.literal( "a" -> a.asInstanceOf[js.Any], "b" -> b.asInstanceOf[js.Any] ) _obj$.asInstanceOf[Foo] } }` This variant removes trailing commas for formatter that complains trailing commas. However, trailing commas are often preferred to reduce code diff./

interface Foo {
  a: string;
  b: number;
}

// no factory generated

This can reduce size of type definition.

object Foo {
  def apply(
    a: String,
    b: Double,
  ): Foo = {
    val _obj$ = js.Dynamic.literal(
      "a" -> a.asInstanceOf[js.Any],
      "b" -> b.asInstanceOf[js.Any],
    )
    _obj$.asInstanceOf[Foo]
  }
}

These methods are useful if traits are generated as @js.native marked trait, since such trait can not be directly constructed.

object Foo {
  def apply(
    a: String,
    b: Double
  ): Foo = {
    val _obj$ = js.Dynamic.literal(
      "a" -> a.asInstanceOf[js.Any],
      "b" -> b.asInstanceOf[js.Any]
    )
    _obj$.asInstanceOf[Foo]
  }
}

This variant removes trailing commas for formatter that complains trailing commas. However, trailing commas are often preferred to reduce code diff./

Do not generate

Generate (recommended)

Generate with no trailing comma

Generate pseudo-enums for type aliases of constants (String, Number, Boolean), or not.

Given "Do not generate" "Generate"

Given	"Do not generate"	"Generate"
`type ErrorCode = 'FORBIDDEN' \| 'INVALID-BODY' \| 400;`	`type ErrorCode = String \| Int` This can reduce size of type definition, but type-safeness is poor.	@js.native sealed trait ErrorCode extends js.Any {} object ErrorCode { @inline val FORBIDDEN: ErrorCode = "FORBIDDEN".asInstanceOf[ErrorCode] @inline val `INVALID-BODY`: ErrorCode = "INVALID-BODY".asInstanceOf[ErrorCode] @inline val `400`: ErrorCode = 400.asInstanceOf[ErrorCode] } This variant generates constants that pretend like enum (instances of sealed trait)./

type ErrorCode
  = 'FORBIDDEN' | 'INVALID-BODY' | 400;

type ErrorCode = String | Int

This can reduce size of type definition, but type-safeness is poor.

@js.native
sealed trait ErrorCode extends js.Any {}
object ErrorCode {
  @inline val FORBIDDEN: ErrorCode
    = "FORBIDDEN".asInstanceOf[ErrorCode]
  @inline val `INVALID-BODY`: ErrorCode
    = "INVALID-BODY".asInstanceOf[ErrorCode]
  @inline val `400`: ErrorCode
    = 400.asInstanceOf[ErrorCode]
}

This variant generates constants that pretend like enum (instances of sealed trait)./

Do not generate

Generate (recommended)

Importing

Type Definition Importer for Scala.js

TypeScript
Put some type description files (*.d.ts).

Scala.js
Get the results.

Type Definition Importer for Scala.js

TypeScript Put some type description files (*.d.ts).

Scala.js Get the results.

TypeScript
Put some type description files (*.d.ts).

Scala.js
Get the results.