@vltpkg/init

Type Aliases

CustomizableInitOptions

type CustomizableInitOptions = object

Defined in: index.ts:18

Type declaration

author

author: string

name

name: string

---

InitFileResults

type InitFileResults = object

Defined in: index.ts:39

Type declaration

manifest?

optional manifest: JSONFileInfo<Manifest>;

---

InitOptions

type InitOptions = object

Defined in: index.ts:12

Type declaration

author?

optional author: string;

cwd?

optional cwd: string;

logger()?

optional logger: (...a) => void;

Parameters

a

…unknown[]

Returns

void

---

JSONFileInfo<T>

type JSONFileInfo<T> = object

Defined in: index.ts:34

Type Parameters

• T extends JSONObj = JSONObj

Type declaration

data

data: T

path

path: string

Functions

getAuthorFromGitUser()

function getAuthorFromGitUser(user?): string

Defined in: get-author-from-git-user.ts:3

Parameters

user?

GitUser

Returns

string

---

init()

function init(__namedParameters): Promise<InitFileResults>

Defined in: index.ts:47

Parameters

__namedParameters

InitOptions = {}

Returns

Promise<InitFileResults>