@vtj • Docs

---

@vtj / renderer / Provider

Class: Provider

Extends

• Base

Constructors

new Provider()

new Provider(options): Provider

Parameters

• options: ProviderOptions

Returns

Provider

Overrides

Base.constructor

Defined in

packages/renderer/types/provider/provider.d.ts:50

Properties

adapter

adapter: ProvideAdapter

Defined in

packages/renderer/types/provider/provider.d.ts:38

---

apis

apis: Record<string, (...args) => Promise<any>>

Defined in

packages/renderer/types/provider/provider.d.ts:39

---

components

components: Record<string, any>

Defined in

packages/renderer/types/provider/provider.d.ts:45

---

dependencies

dependencies: Record<string, () => Promise<any>>

Defined in

packages/renderer/types/provider/provider.d.ts:40

---

globals

globals: Record<string, any>

Defined in

packages/renderer/types/provider/provider.d.ts:36

---

isReady

protected isReady: boolean

Inherited from

Base.isReady

Defined in

packages/core/types/models/base.d.ts:3

---

library

library: Record<string, any>

Defined in

packages/renderer/types/provider/provider.d.ts:42

---

listeners

protected listeners: () => void[]

Inherited from

Base.listeners

Defined in

packages/core/types/models/base.d.ts:2

---

materials

materials: Record<string, () => Promise<any>>

Defined in

packages/renderer/types/provider/provider.d.ts:41

---

mode

mode: ContextMode

Defined in

packages/renderer/types/provider/provider.d.ts:35

---

modules

modules: Record<string, () => Promise<any>>

Defined in

packages/renderer/types/provider/provider.d.ts:37

---

nodeEnv

nodeEnv: NodeEnv

Defined in

packages/renderer/types/provider/provider.d.ts:46

---

options

options: ProviderOptions

Defined in

packages/renderer/types/provider/provider.d.ts:34

---

project

project: null | ProjectSchema

Defined in

packages/renderer/types/provider/provider.d.ts:44

---

service

service: Service

Defined in

packages/renderer/types/provider/provider.d.ts:43

Methods

createDslRenderer()

createDslRenderer(dsl, opts?): object

Parameters

• dsl: BlockSchema

• opts?: Partial<CreateRendererOptions>

Returns

object

context

context: Context

renderer

renderer: any

Defined in

packages/renderer/types/provider/provider.d.ts:61

---

definePluginComponent()

definePluginComponent(from): any

Parameters

• from: NodeFromPlugin

Returns

any

Defined in

packages/renderer/types/provider/provider.d.ts:67

---

defineUrlSchemaComponent()

defineUrlSchemaComponent(url, name?): any

Parameters

• url: string

• name?: string

Returns

any

Defined in

packages/renderer/types/provider/provider.d.ts:66

---

getDsl()

getDsl(id): Promise<null | BlockSchema>

Parameters

• id: string

Returns

Promise<null | BlockSchema>

Defined in

packages/renderer/types/provider/provider.d.ts:59

---

getDslByUrl()

getDslByUrl(url): Promise<null | BlockSchema>

Parameters

• url: string

Returns

Promise<null | BlockSchema>

Defined in

packages/renderer/types/provider/provider.d.ts:60

---

getFile()

getFile(id): null | PageFile | BlockFile

Parameters

• id: string

Returns

null | PageFile | BlockFile

Defined in

packages/renderer/types/provider/provider.d.ts:56

---

getHomepage()

getHomepage(): null | PageFile

Returns

null | PageFile

Defined in

packages/renderer/types/provider/provider.d.ts:58

---

getPage()

getPage(id): null | PageFile

Parameters

• id: string

Returns

null | PageFile

Defined in

packages/renderer/types/provider/provider.d.ts:57

---

getRenderComponent()

getRenderComponent(id): Promise<any>

Parameters

• id: string

Returns

Promise<any>

Defined in

packages/renderer/types/provider/provider.d.ts:65

---

install()

install(app): void

Parameters

• app: App<any>

Returns

void

Defined in

packages/renderer/types/provider/provider.d.ts:55

---

load()

load(project): Promise<void>

Parameters

• project: ProjectSchema

Returns

Promise<void>

Defined in

packages/renderer/types/provider/provider.d.ts:51

---

ready()

ready(callback): void

Parameters

• callback

Returns

void

Inherited from

Base.ready

Defined in

packages/core/types/models/base.d.ts:5

---

resetReady()

resetReady(): void

Returns

void

Inherited from

Base.resetReady

Defined in

packages/core/types/models/base.d.ts:6

---

triggerReady()

protected triggerReady(): void

Returns

void

Inherited from

Base.triggerReady

Defined in

packages/core/types/models/base.d.ts:4