server-renderer.d.ts 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. /// <reference types="node" />
  2. import { App } from 'vue';
  3. import { Component } from 'vue';
  4. import { ComponentInternalInstance } from 'vue';
  5. import { ComponentPublicInstance } from '@vue/runtime-core';
  6. import { Directive } from '@vue/runtime-core';
  7. import { Readable } from 'stream';
  8. import { Slots } from 'vue';
  9. import { includeBooleanAttr as ssrIncludeBooleanAttr } from '@vue/shared';
  10. import { VNode } from 'vue';
  11. import { Writable } from 'stream';
  12. export declare function pipeToNodeWritable(input: App | VNode, context: SSRContext | undefined, writable: Writable): void;
  13. export declare function pipeToWebWritable(input: App | VNode, context: SSRContext | undefined, writable: WritableStream): void;
  14. declare type Props = Record<string, unknown>;
  15. declare type PushFn = (item: SSRBufferItem) => void;
  16. export declare function renderToNodeStream(input: App | VNode, context?: SSRContext): Readable;
  17. export declare function renderToSimpleStream<T extends SimpleReadable>(input: App | VNode, context: SSRContext, stream: T): T;
  18. /**
  19. * @deprecated
  20. */
  21. export declare function renderToStream(input: App | VNode, context?: SSRContext): Readable;
  22. export declare function renderToString(input: App | VNode, context?: SSRContext): Promise<string>;
  23. export declare function renderToWebStream(input: App | VNode, context?: SSRContext): ReadableStream;
  24. export declare interface SimpleReadable {
  25. push(chunk: string | null): void;
  26. destroy(err: any): void;
  27. }
  28. declare type SSRBuffer = SSRBufferItem[] & {
  29. hasAsync?: boolean;
  30. };
  31. declare type SSRBufferItem = string | SSRBuffer | Promise<SSRBuffer>;
  32. export declare type SSRContext = {
  33. [key: string]: any;
  34. teleports?: Record<string, string>;
  35. /* Excluded from this release type: __teleportBuffers */
  36. /* Excluded from this release type: __watcherHandles */
  37. };
  38. export declare function ssrGetDirectiveProps(instance: ComponentPublicInstance, dir: Directive, value?: any, arg?: string, modifiers?: Record<string, boolean>): Record<string, any>;
  39. export declare function ssrGetDynamicModelProps(existingProps: any, model: unknown): {
  40. checked: boolean;
  41. value?: undefined;
  42. } | {
  43. value: unknown;
  44. checked?: undefined;
  45. } | null;
  46. export { ssrIncludeBooleanAttr }
  47. export declare function ssrInterpolate(value: unknown): string;
  48. export declare function ssrLooseContain(arr: unknown[], value: unknown): boolean;
  49. export declare const ssrLooseEqual: (a: unknown, b: unknown) => boolean;
  50. export declare function ssrRenderAttr(key: string, value: unknown): string;
  51. export declare function ssrRenderAttrs(props: Record<string, unknown>, tag?: string): string;
  52. export declare function ssrRenderClass(raw: unknown): string;
  53. export declare function ssrRenderComponent(comp: Component, props?: Props | null, children?: Slots | SSRSlots | null, parentComponent?: ComponentInternalInstance | null, slotScopeId?: string): SSRBuffer | Promise<SSRBuffer>;
  54. export declare function ssrRenderDynamicAttr(key: string, value: unknown, tag?: string): string;
  55. export declare function ssrRenderDynamicModel(type: unknown, model: unknown, value: unknown): string;
  56. export declare function ssrRenderList(source: unknown, renderItem: (value: unknown, key: string | number, index?: number) => void): void;
  57. export declare function ssrRenderSlot(slots: Slots | SSRSlots, slotName: string, slotProps: Props, fallbackRenderFn: (() => void) | null, push: PushFn, parentComponent: ComponentInternalInstance, slotScopeId?: string): void;
  58. export declare function ssrRenderSlotInner(slots: Slots | SSRSlots, slotName: string, slotProps: Props, fallbackRenderFn: (() => void) | null, push: PushFn, parentComponent: ComponentInternalInstance, slotScopeId?: string, transition?: boolean): void;
  59. export declare function ssrRenderStyle(raw: unknown): string;
  60. export declare function ssrRenderSuspense(push: PushFn, { default: renderContent }: Record<string, (() => void) | undefined>): Promise<void>;
  61. export declare function ssrRenderTeleport(parentPush: PushFn, contentRenderFn: (push: PushFn) => void, target: string, disabled: boolean, parentComponent: ComponentInternalInstance): void;
  62. export declare function ssrRenderVNode(push: PushFn, vnode: VNode, parentComponent: ComponentInternalInstance, slotScopeId?: string): void;
  63. declare type SSRSlot = (props: Props, push: PushFn, parentComponent: ComponentInternalInstance | null, scopeId: string | null) => void;
  64. declare type SSRSlots = Record<string, SSRSlot>;
  65. export { }