@vtj / Modules / renderer / Provider

Class: Provider

renderer.Provider

Hierarchy

• Base

  ↳ Provider

Table of contents

Constructors

• constructor

Properties

• adapter
• apis
• components
• dependencies
• globals
• initRouter
• isReady
• library
• listeners
• materialPath
• materials
• mode
• modules
• nodeEnv
• project
• router
• service
• urlDslCaches

Methods

• createDslRenderer
• definePluginComponent
• defineUrlSchemaComponent
• getDsl
• getDslByUrl
• getFile
• getHomepage
• getPage
• getRenderComponent
• install
• load
• ready
• resetReady
• triggerReady

Constructors

constructor

• new Provider(options): Provider

Parameters

Name	Type
options	ProviderOptions

Returns

Provider

Overrides

Base.constructor

Defined in

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

Properties

adapter

• adapter: ProvideAdapter

Defined in

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

---

apis

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

Defined in

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

---

components

• components: Record<string, any>

Defined in

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

---

dependencies

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

Defined in

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

---

globals

• globals: Record<string, any>

Defined in

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

---

initRouter

• Private initRouter: any

Defined in

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

---

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:34

---

listeners

• Protected listeners: () => void[]

Inherited from

Base.listeners

Defined in

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

---

materialPath

• Private materialPath: any

Defined in

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

---

materials

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

Defined in

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

---

mode

• mode: ContextMode

Defined in

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

---

modules

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

Defined in

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

---

nodeEnv

• nodeEnv: "development" | "production"

Defined in

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

---

project

• project: null | ProjectSchema

Defined in

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

---

router

• Private router: any

Defined in

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

---

service

• service: Service

Defined in

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

---

urlDslCaches

• Private urlDslCaches: any

Defined in

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

Methods

createDslRenderer

▸ createDslRenderer(dsl, opts?): Object

Parameters

Name	Type
dsl	BlockSchema
opts?	Partial<CreateRendererOptions>

Returns

Object

Name	Type
context	Context
renderer	any

Defined in

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

---

definePluginComponent

▸ definePluginComponent(from): any

Parameters

Name	Type
from	NodeFromPlugin

Returns

any

Defined in

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

---

defineUrlSchemaComponent

▸ defineUrlSchemaComponent(url, name?): any

Parameters

Name	Type
url	string
name?	string

Returns

any

Defined in

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

---

getDsl

▸ getDsl(id): Promise<null | BlockSchema>

Parameters

Name	Type
id	string

Returns

Promise<null | BlockSchema>

Defined in

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

---

getDslByUrl

▸ getDslByUrl(url): Promise<null | BlockSchema>

Parameters

Name	Type
url	string

Returns

Promise<null | BlockSchema>

Defined in

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

---

getFile

▸ getFile(id): null | PageFile | BlockFile

Parameters

Name	Type
id	string

Returns

null | PageFile | BlockFile

Defined in

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

---

getHomepage

▸ getHomepage(): null | PageFile

Returns

null | PageFile

Defined in

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

---

getPage

▸ getPage(id): null | PageFile

Parameters

Name	Type
id	string

Returns

null | PageFile

Defined in

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

---

getRenderComponent

▸ getRenderComponent(id): Promise<any>

Parameters

Name	Type
id	string

Returns

Promise<any>

Defined in

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

---

install

▸ install(app): void

Parameters

Name	Type
app	App<any>

Returns

void

Defined in

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

---

load

▸ load(project): Promise<void>

Parameters

Name	Type
project	ProjectSchema

Returns

Promise<void>

Defined in

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

---

ready

▸ ready(callback): void

Parameters

Name	Type
callback	() => void

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

▸ triggerReady(): void

Returns

void

Inherited from

Base.triggerReady

Defined in

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