Class ContentService

see docs/content.md

Todo

migrate markdown docs across.

Hierarchy

ContentService

Index

Constructors

Methods

contentIterator processMarkdown processRepository validateContent

Constructors

constructor

new ContentService(context: Context): ContentService
Parameters
- context: Context
Returns ContentService
- Defined in src/content/content-service.ts:45

Methods

contentIterator

contentIterator(directory: string, contentKeys: string[], languages: string[]): AsyncGenerator<{
files: Record<string, string>;
key: string;
}[], void, unknown>
Parameters
- directory: string
- contentKeys: string[]
- languages: string[]
Returns AsyncGenerator<{
files: Record<string, string>;
key: string;
}[], void, unknown>
- Defined in src/content/content-service.ts:104

processMarkdown

processMarkdown(markdown: string): string
Take markdown in a string, process %custom_tags% and return a new string
Parameters
- markdown: string
Returns string
- Defined in src/content/content-service.ts:149

processRepository

processRepository(options: ProcessRepoOptions, callback?: ProcessRepoCallback): Promise<void>
Parameters
- options: ProcessRepoOptions
- Optional callback: ProcessRepoCallback
Returns Promise<void>
- Defined in src/content/content-service.ts:49

validateContent

validateContent<T>(directory: string, languages: T[]): Promise<Record<T, string>>
Type Parameters
- T extends string
Parameters
- directory: string
- languages: T[]
Returns Promise<Record<T, string>>
- Defined in src/content/content-service.ts:129

Generated using TypeDoc