HydrationBoundary

类: HydrationBoundary<Props, Events, Slots>

Svelte 组件的基础类,带有一些小的开发增强功能。在 dev=true 时使用。

可以用于创建强类型的 Svelte 组件。

示例

你有一个 npm 上的组件库名为 component-library,你从中导出一个名为 MyComponent 的组件。对于 Svelte+TypeScript 用户,你想要提供类型定义。因此你创建了一个 index.d.ts

ts
import { SvelteComponent } from 'svelte'
export class MyComponent extends SvelteComponent<{ foo: string }> {}
import { SvelteComponent } from 'svelte'
export class MyComponent extends SvelteComponent<{ foo: string }> {}

这样进行类型定义使得像 VS Code 这样的 IDE 配合 Svelte 扩展可以提供智能提示,并且可以在带有 TypeScript 的 Svelte 文件中像这样使用组件

svelte
<script lang="ts">
  import { MyComponent } from 'component-library'
</script>

<MyComponent foo={'bar'} />
<script lang="ts">
  import { MyComponent } from 'component-library'
</script>

<MyComponent foo={'bar'} />

继承自

  • SvelteComponent_1<Props, Events>

类型参数

Props extends Record<string, any> = any

Events extends Record<string, any> = any

Slots extends Record<string, any> = any

可索引

[prop: string]: any

构造函数

new HydrationBoundary()

ts
new HydrationBoundary<Props, Events, Slots>(options): HydrationBoundary<Props, Events, Slots>
new HydrationBoundary<Props, Events, Slots>(options): HydrationBoundary<Props, Events, Slots>

参数

options: ComponentConstructorOptions<Props>

返回值

HydrationBoundary<Props, Events, Slots>

覆盖

SvelteComponent_1<Props, Events>.constructor

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:144

属性

$$

ts
$$: any
$$: any

PRIVATE API

请勿使用,随时可能更改

继承自

SvelteComponent_1.$$

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:102


$$events_def

ts
$$events_def: Events
$$events_def: Events

仅用于类型检查功能。运行时不存在。

请勿使用!

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:158


$$prop_def

ts
$$prop_def: Props
$$prop_def: Props

仅用于类型检查功能。运行时不存在。

请勿使用!

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:151


$$set

ts
$$set: any
$$set: any

PRIVATE API

请勿使用,随时可能更改

继承自

SvelteComponent_1.$$set

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:109


$$slot_def

ts
$$slot_def: Slots
$$slot_def: Slots

仅用于类型检查功能。运行时不存在。

请勿使用!

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:165

方法

$capture_state()

ts
$capture_state(): void
$capture_state(): void

返回值

void

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:167


$destroy()

ts
$destroy(): void
$destroy(): void

返回值

void

继承自

SvelteComponent_1.$destroy

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:111


$inject_state()

ts
$inject_state(): void
$inject_state(): void

返回值

void

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:169


$on()

ts
$on<K>(type, callback): () => void
$on<K>(type, callback): () => void

类型参数

K extends string

参数

type: K

callback: undefined | null | (e) => void

返回值

函数

返回值

void

继承自

SvelteComponent_1.$on

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:113


$set()

ts
$set(props): void
$set(props): void

参数

props: Partial<Props>

返回值

void

继承自

SvelteComponent_1.$set

定义于

node_modules/.pnpm/svelte@4.2.18/node_modules/svelte/types/index.d.ts:115