Module: @kosko/template

Index

References

• File
• Result
• Template
• run
• writeFiles

Interfaces

• File
• Result
• Template

Functions

• run
• writeFiles

References

File

Re-exports: File

---

Result

Re-exports: Result

---

Template

Re-exports: Template

---

run

Re-exports: run

---

writeFiles

Re-exports: writeFiles

Functions

run

▸ run(template: Template<any>, argv?: string[]): Promise<void>

Defined in packages/template/src/cli.ts:14

Parse command line arguments and generate files with a template.

Parameters:

Name	Type	Default value	Description
template	Template<any>	-	Template
argv	string[]	process.argv.slice(2)	Command line arguments

Returns: Promise<void>

---

writeFiles

▸ writeFiles(path: string, files: ReadonlyArray<File>): Promise<void>

Defined in packages/template/src/write.ts:16

Write files to the specified path.

Parameters:

Name	Type	Description
path	string	Destination path
files	ReadonlyArray<File>	Files to write

Returns: Promise<void>