Class default

Hierarchy

default

Index

Constructors

Properties

config cwd getConfig setConfig currentApI

Methods

clean copy generate safelink seo standalone getApi setApi

Constructors

constructor

new default(cwd: Nullable<string>, options?: Record<string, any> | ProjConf): default
Static blog generator
Parameters
- cwd: Nullable<string>
  
  base folder
- Optional options: Record<string, any> | ProjConf
Returns default
- Defined in src/api.ts:24

Properties

config

config: ProjConf = ...

cwd

cwd: string

getConfig

getConfig: (() => ProjConf) = getConfig

Type declaration

- (): ProjConf
- Config getter
  - useful for jest
  Returns
  Returns ProjConf

setConfig

setConfig: ((obj: Record<string, any> | ProjConf) => ProjConf) = setConfig

Type declaration

- (obj: Record<string, any> | ProjConf): ProjConf
- Config setter
  - useful for jest
  Parameters
  - obj: Record<string, any> | ProjConf
  Returns ProjConf

`Static` currentApI

currentApI: default

Methods

clean

clean(opt?: "post" | "all" | "archive" | "database"): Promise<void>
clean cache, auto generated posts, etc

See
- cleaner.cleanDb
- cleaner.cleanArchive
Parameters
- Optional opt: "post" | "all" | "archive" | "database"
Returns Promise<void>
- Defined in src/api.ts:86

copy

copy(): Promise<void>
Copy all src-post to source/_posts (run before generate)
- see the method pcopy.copyAllPosts
Returns
Returns Promise<void>
- Defined in src/api.ts:60

generate

generate(): Promise<void>
generate site with hexo

Returns Promise<void>
- Defined in src/api.ts:71

safelink

safelink(): WriteStream | ReadWriteStream
Anonymize external links on public dir (_config_yml.public_dir) (run after generated)

Returns

Returns WriteStream | ReadWriteStream
- Defined in src/api.ts:66

seo

seo(): ReadWriteStream
Auto seo on public dir (_config_yml.public_dir) (run after generated)

Returns

Returns ReadWriteStream
- Defined in src/api.ts:53

standalone

standalone(): Promise<void>
run files ends with standalone.js inside source posts standaloneRunner

Returns

Returns Promise<void>
- Defined in src/api.ts:47

`Static` getApi

getApi(): default
Returns default
- Defined in src/api.ts:39

`Static` setApi

setApi(api: default): void
Parameters
- api: default
Returns void
- Defined in src/api.ts:36