vue Architecture Docs
Home / File/ index.d.ts — vue Source File

index.d.ts — vue Source File

Architecture documentation for index.d.ts, a typescript file in the vue codebase. 2 imports, 0 dependents.

File typescript VueCore Observer 2 imports 5 functions 2 classes

Entity Profile

Dependency Diagram

graph LR
  68a64c43_06dc_18e6_a79c_843ed50d8ce7["index.d.ts"]
  db9e7bef_009d_3918_6e7d_543a36a38d75["vue"]
  68a64c43_06dc_18e6_a79c_843ed50d8ce7 --> db9e7bef_009d_3918_6e7d_543a36a38d75
  7aef85ef_4754_53fb_5d94_f8411adf9a0a["stream"]
  68a64c43_06dc_18e6_a79c_843ed50d8ce7 --> 7aef85ef_4754_53fb_5d94_f8411adf9a0a
  style 68a64c43_06dc_18e6_a79c_843ed50d8ce7 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

import Vue, { VNode, VNodeDirective } from 'vue'
import { Readable } from 'stream'

export declare function createRenderer(options?: RendererOptions): Renderer

export declare function createBundleRenderer(
  bundle: string | object,
  options?: BundleRendererOptions
): BundleRenderer

type RenderCallback = (err: Error | null, html: string) => void

interface Renderer {
  renderToString(vm: Vue, callback: RenderCallback): void
  renderToString(vm: Vue, context: object, callback: RenderCallback): void
  renderToString(vm: Vue): Promise<string>
  renderToString(vm: Vue, context: object): Promise<string>

  renderToStream(vm: Vue, context?: object): Readable
}

interface BundleRenderer {
  renderToString(callback: RenderCallback): void
  renderToString(context: object, callback: RenderCallback): void
  renderToString(): Promise<string>
  renderToString(context: object): Promise<string>

  renderToStream(context?: object): Readable
}

interface RendererOptions {
  template?: string
  inject?: boolean
  shouldPreload?: (file: string, type: string) => boolean
  shouldPrefetch?: (file: string, type: string) => boolean
  cache?: RenderCache
  directives?: {
    [key: string]: (vnode: VNode, dir: VNodeDirective) => void
  }
}

interface BundleRendererOptions extends RendererOptions {
  clientManifest?: object
  serializer?: (state: object) => string
  runInNewContext?: boolean | 'once'
  basedir?: string
}

interface RenderCache {
  get: (key: string, cb?: (res: string) => void) => string | void
  set: (key: string, val: string) => void
  has?: (key: string, cb?: (hit: boolean) => void) => boolean | void
}

Domain

Subdomains

Functions

Classes

Types

Dependencies

  • stream
  • vue

Source

Frequently Asked Questions

What does index.d.ts do?
index.d.ts is a source file in the vue codebase, written in typescript. It belongs to the VueCore domain, Observer subdomain.
What functions are defined in index.d.ts?
index.d.ts defines 5 function(s): err, file, key, state, vnode.
What does index.d.ts depend on?
index.d.ts imports 2 module(s): stream, vue.
Where is index.d.ts in the architecture?
index.d.ts is located at packages/server-renderer/types/index.d.ts (domain: VueCore, subdomain: Observer, directory: packages/server-renderer/types).

Analyze Your Own Codebase

Get architecture documentation, dependency graphs, and domain analysis for your codebase in minutes.

Try Supermodel Free