API Reference
build
Build your project.
Usage
ts
import { build } from 'velite'Signature
ts
const build: (options?: Options) => Promise<Result>Parameters
options
- Type:
Options, See Options.
Options for build.
options.config
- Type:
string
Specify the config file path.
options.clean
- Type:
boolean - Default:
false
Clean output directories before build.
options.watch
- Type:
boolean - Default:
false
Watch files and rebuild on changes.
options.logLevel
- Type:
'debug' | 'info' | 'warn' | 'error' | 'silent' - Default:
'info'
Log level.
options.strict
- Type:
boolean - Default:
false
If true, throws an error and terminates the process if any schema validation fails. Otherwise, a warning is logged but the process does not terminate.
Returns
- Type:
Promise<Result>, See Result.
The build result.
Types
Options
ts
interface Options {
/**
* Specify config file path
* @default 'velite.config.{js,ts,mjs,mts,cjs,cts}'
*/
config?: string
/**
* Clean output directories before build
* @default false
*/
clean?: boolean
/**
* Watch files and rebuild on changes
* @default false
*/
watch?: boolean
/**
* Log level
* @default 'info'
*/
logLevel?: LogLevel
}Result
ts
interface Entry {
[key: string]: any
}
/**
* build result, may be one or more entries in a document file
*/
interface Result {
[name: string]: Entry | Entry[]
}outputFile
Signature
ts
const outputFile: async <T extends string | undefined>(ref: T, fromPath: string) => Promise<T>outputImage
Signature
ts
const outputImage: async <T extends string | undefined>(ref: T, fromPath: string) => Promise<Image | T>cache
loaded:${path}: VFile of loaded file.
...