mill-libs-javascriptlib
API
Generated with
mill-libs-javascriptlib/mill.javascriptlib/TypeScriptModule

TypeScriptModule

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

Attributes

Companion
object
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

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
Supertypes
class Internal
class Object
trait Matchable
class Any

Value members

Concrete methods

def bundle: Simple[PathRef]
def bundleExternal: Simple[Seq[Value]]
def bundleFlags: Simple[Map[String, Value]]
@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

def compile: Simple[PathRef]
def compilerOptions: Simple[Map[String, Value]]
def compilerOptionsBuilder: Task[Map[String, Value]]
def compilerOptionsPaths: Simple[Map[String, String]]
def computedArgs: Simple[Seq[String]]
@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 `Task.workspace`.\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 Task.workspace.

Attributes

def declarationDir: Simple[String]
def enableEsm: Simple[Boolean]
def executionFlags: Simple[Map[String, String]]
def forkEnv: Simple[Map[String, String]]
def generatedSources: Simple[Seq[PathRef]]
def generatedSourcesPathsBuilder: Simple[Seq[(String, String)]]
def mainFileName: Simple[String]
def mainFilePath: Simple[Path]
def moduleName: String
def modulePaths: Simple[Seq[(String, String)]]
def npmDeps: Simple[Seq[String]]
def npmDevDeps: Simple[Seq[String]]
def npmInstall: Simple[PathRef]
def npmRc: Simple[PathRef]
def options: Simple[Map[String, Value]]
def packageJson: Simple[PackageJson]
def resources: Simple[Seq[PathRef]]
def run(args: Args): Command[CommandResult]
@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

def sources: Simple[Seq[PathRef]]
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
def transitiveNpmDeps: Simple[Seq[String]]
def transitiveNpmDevDeps: Simple[Seq[String]]
def transitiveUnmanagedDeps: Simple[Seq[PathRef]]
@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

def tscAllSources: Simple[IndexedSeq[String]]
def tscCopySources: Task[Unit]
def typeRoots: Task[Value]
def unmanagedDeps: Simple[Seq[PathRef]]
def upstreamPathsBuilder: Simple[Seq[(String, String)]]

Inherited methods

def moduleCtx: ModuleCtx

Attributes

Inherited from:
BaseClass
def moduleDir: Path

Attributes

Inherited from:
Module
def moduleDirJava: Path

Attributes

Inherited from:
Module
def moduleDirectChildren: Seq[Module]

Attributes

Inherited from:
Module
def moduleSegments: Segments

Attributes

Inherited from:
Module

Implicits

Inherited implicits

implicit def moduleNestedCtx: Nested

Attributes

Inherited from:
Module
Generated with