Mill
API
Generated with
Mill/mill/mill.javascriptlib/TypeScriptModule

TypeScriptModule

mill.javascriptlib.TypeScriptModule
See theTypeScriptModule companion object
trait TypeScriptModule extends Module

Attributes

Companion
object
Source
TypeScriptModule.scala
Graph
Supertypes
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all
Known subtypes
trait Coverage
trait Jasmine
trait Jest
trait Mocha
trait Vitest
trait Cypress
trait PlayWright
trait Shared
Show all
Self type

Members list

Type members

Classlikes

trait TypeScriptTests extends TypeScriptModule

Attributes

Source
TypeScriptModule.scala
Supertypes
trait Module
trait ModuleApi
trait Wrapper
class BaseClass
trait Cacher
trait Cacher
class Object
trait Matchable
class Any
Show all

Inherited classlikes

@Scaladoc(value = "/**\n * Miscellaneous machinery around traversing & querying the build hierarchy,\n * that should not be needed by normal users of Mill\n */")
object moduleInternal extends Internal

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Miscellaneous machinery around traversing & querying the build hierarchy, that should not be needed by normal users of Mill

Attributes

Inherited from:
Module
Source
Module.scala
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Concrete methods

def bundle: Simple[PathRef]

Attributes

Source
TypeScriptModule.scala
def bundleExternal: Simple[Seq[Value]]

Attributes

Source
TypeScriptModule.scala
def bundleFlags: Simple[Map[String, Value]]

Attributes

Source
TypeScriptModule.scala
@Scaladoc(value = "/**\n * configure esbuild with `@esbuild-plugins/tsconfig-paths`\n * include .d.ts files\n */")
def bundleScriptBuilder: Task[String]

configure esbuild with @esbuild-plugins/tsconfig-paths include .d.ts files

configure esbuild with @esbuild-plugins/tsconfig-paths include .d.ts files

Attributes

Source
TypeScriptModule.scala
def compile: Simple[PathRef]

Attributes

Source
TypeScriptModule.scala
def compilerOptions: Simple[Map[String, Value]]

Attributes

Source
TypeScriptModule.scala
def compilerOptionsBuilder: Task[Map[String, Value]]

Attributes

Source
TypeScriptModule.scala
def compilerOptionsPaths: Simple[Map[String, String]]

Attributes

Source
TypeScriptModule.scala
def computedArgs: Simple[Seq[String]]

Attributes

Source
TypeScriptModule.scala
@Scaladoc(value = "/**\n * Mill by default will use local tsconfig if one is provided,\n * This can set to `false` if you would prefer mill to use the generated\n * tsconfig, if you can not for some reason just not delete the local one.\n *\n * Regardless of the configuration, mill will auto gen a tsconfig\n * if one does not exist in `BuildCtx.workspaceRoot`.\n */")
def customTsConfig: Simple[Boolean]

Mill by default will use local tsconfig if one is provided, This can set to false if you would prefer mill to use the generated tsconfig, if you can not for some reason just not delete the local one.

Mill by default will use local tsconfig if one is provided, This can set to false if you would prefer mill to use the generated tsconfig, if you can not for some reason just not delete the local one.

Regardless of the configuration, mill will auto gen a tsconfig if one does not exist in BuildCtx.workspaceRoot.

Attributes

Source
TypeScriptModule.scala
def declarationDir: Simple[String]

Attributes

Source
TypeScriptModule.scala
def enableEsm: Simple[Boolean]

Attributes

Source
TypeScriptModule.scala
def executionFlags: Simple[Map[String, String]]

Attributes

Source
TypeScriptModule.scala
def forkEnv: Simple[Map[String, String]]

Attributes

Source
TypeScriptModule.scala
def generatedSources: Simple[Seq[PathRef]]

Attributes

Source
TypeScriptModule.scala
def generatedSourcesPathsBuilder: Simple[Seq[(String, String)]]

Attributes

Source
TypeScriptModule.scala
def mainFileName: Simple[String]

Attributes

Source
TypeScriptModule.scala
def mainFilePath: Simple[Path]

Attributes

Source
TypeScriptModule.scala
def moduleDeps: Seq[TypeScriptModule]

Attributes

Source
TypeScriptModule.scala
def moduleName: String

Attributes

Source
TypeScriptModule.scala
def modulePaths: Simple[Seq[(String, String)]]

Attributes

Source
TypeScriptModule.scala
def npmDeps: Simple[Seq[String]]

Attributes

Source
TypeScriptModule.scala
def npmDevDeps: Simple[Seq[String]]

Attributes

Source
TypeScriptModule.scala
def npmRc: Simple[PathRef]

Attributes

Source
TypeScriptModule.scala
def options: Simple[Map[String, Value]]

Attributes

Source
TypeScriptModule.scala
def resources: Simple[Seq[PathRef]]

Attributes

Source
TypeScriptModule.scala
def run(args: Args): Command[CommandResult]

Attributes

Source
TypeScriptModule.scala
@Scaladoc(value = "/**\n * Run `ts-node` command if set to `true`.\n * `ts-node` will build declarations and or js output, depending on ts-config.\n */")
def runTypeCheck: Simple[Boolean]

Run ts-node command if set to true. ts-node will build declarations and or js output, depending on ts-config.

Run ts-node command if set to true. ts-node will build declarations and or js output, depending on ts-config.

Attributes

Source
TypeScriptModule.scala
def sources: Simple[Seq[PathRef]]

Attributes

Source
TypeScriptModule.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
Module -> Any
Source
TypeScriptModule.scala
def transitiveNpmDeps: Simple[Seq[String]]

Attributes

Source
TypeScriptModule.scala
def transitiveNpmDevDeps: Simple[Seq[String]]

Attributes

Source
TypeScriptModule.scala
@Scaladoc(value = "/**\n * Typescript versioning:\n * - typescript\n * - ts-node\n * - tsconfig-paths\n * - @types/node\n */")
def tsDeps: Simple[Seq[String]]

Typescript versioning:

Typescript versioning:

  • typescript
  • ts-node
  • tsconfig-paths
  • @types/node

Attributes

Source
TypeScriptModule.scala
def tscAllSources: Simple[IndexedSeq[String]]

Attributes

Source
TypeScriptModule.scala
def tscCopySources: Task[Unit]

Attributes

Source
TypeScriptModule.scala
def typeRoots: Task[Value]

Attributes

Source
TypeScriptModule.scala
def unmanagedDeps: Simple[Seq[PathRef]]

Attributes

Source
TypeScriptModule.scala
def upstreamPathsBuilder: Simple[Seq[(String, String)]]

Attributes

Source
TypeScriptModule.scala

Inherited methods

def moduleCtx: ModuleCtx

Attributes

Inherited from:
BaseClass
Source
Module.scala
def moduleDir: Path

Attributes

Inherited from:
Module
Source
Module.scala
def moduleDirJava: Path

Attributes

Inherited from:
Module
Source
Module.scala
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
Source
Module.scala
def moduleSegments: Segments

Attributes

Inherited from:
Module
Source
Module.scala
Generated with