Test overview
Added in v1.0.0
Table of contents
utils
EventOptions (type alias)
Signature
export type EventOptions = {
readonly event: string
readonly selector?: string
readonly eventInit?: EventInit
}
Added in v1.0.0
HappyDOMOptions (type alias)
Signature
export type HappyDOMOptions = ConstructorParameters<typeof import("happy-dom").Window>[0]
TestHydrate (interface)
Signature
export interface TestHydrate<E, Elements> extends TestRender<E> {
readonly elements: Elements
}
Added in v1.0.0
TestRender (interface)
Signature
export interface TestRender<E> {
readonly window: Window & GlobalThis
readonly document: Document
readonly elementRef: ElementRef.ElementRef
readonly errors: RefSubject.Computed<ReadonlyArray<E>>
readonly lastError: RefSubject.Filtered<E>
readonly interrupt: Effect.Effect<void>
readonly makeEvent: (type: string, eventInitDict?: EventInit) => Event
readonly makeCustomEvent: <A>(type: string, eventInitDict?: CustomEventInit<A>) => CustomEvent<A>
readonly dispatchEvent: (options: EventOptions) => Effect.Effect<void, Cause.NoSuchElementException>
readonly click: (options?: Omit<EventOptions, "event">) => Effect.Effect<void, Cause.NoSuchElementException>
}
Added in v1.0.0
click
Signature
export declare function click<E>(
rendered: Pick<TestRender<E>, "elementRef" | "makeEvent">,
options?: Omit<EventOptions, "event">
)
Added in v1.0.0
dispatchEvent
Signature
export declare function dispatchEvent<E>(
{ elementRef, makeEvent }: Pick<TestRender<E>, "elementRef" | "makeEvent">,
options: EventOptions
)
Added in v1.0.0
getOrMakeWindow
Signature
export declare function getOrMakeWindow(
options?: HappyDOMOptions
): Effect.Effect<Window & GlobalThis, never, Scope.Scope>
isTemplateEndComment
Signature
export declare function isTemplateEndComment(comment: Comment)
isTemplateStartComment
Signature
export declare function isTemplateStartComment(comment: Comment)
stripTypedTemplateComments
Signature
export declare function stripTypedTemplateComments(html: string)
testHtmlChunks
Signature
export declare function testHtmlChunks<E, R>(
fx: Fx.Fx<RenderEvent, E, R>
): Effect.Effect<
ReadonlyArray<string>,
E,
Scope.Scope | Exclude<R, RenderContext.RenderContext | RenderQueue.RenderQueue | RenderTemplate | CurrentEnvironment>
>
Added in v1.0.0
testHtmlString
Signature
export declare function testHtmlString<E, R>(
fx: Fx.Fx<RenderEvent, E, R>
): Effect.Effect<
string,
E,
Scope.Scope | Exclude<R, RenderContext.RenderContext | RenderQueue.RenderQueue | RenderTemplate | CurrentEnvironment>
>
Added in v1.0.0
testHydrate
Signature
export declare function testHydrate<R, E, Elements>(
fx: Fx.Fx<RenderEvent, E, R>,
f: (rendered: Rendered, window: Window & GlobalThis) => Elements,
options?: HappyDOMOptions & {
readonly [K in keyof DomServicesElementParams]?: (document: Document) => DomServicesElementParams[K]
}
): Effect.Effect<
TestHydrate<E, Elements>,
E,
| Scope.Scope
| Exclude<
R,
RenderContext.RenderContext | RenderQueue.RenderQueue | RenderTemplate | CurrentEnvironment | DomServices
>
| Exclude<R, RenderContext.RenderContext | RenderTemplate | CurrentEnvironment | DomServices>
>
Added in v1.0.0
testRender
Signature
export declare function testRender<E, R>(
fx: Fx.Fx<RenderEvent, E, R>,
options?: HappyDOMOptions & {
readonly [K in keyof DomServicesElementParams]?: (document: Document) => DomServicesElementParams[K]
} & { renderTimeout?: DurationInput }
): Effect.Effect<
TestRender<E>,
never,
Scope.Scope | Exclude<R, RenderTemplate | RenderContext.RenderContext | CurrentEnvironment | DomServices>
>
Added in v1.0.0