@amazon/vinyl-util 3.0.1 → 3.1.0

package/dist/types/ts4.1/patch/patchTarget.d.ts

@@ -1,114 +0,0 @@
-import type { Disposable } from '../core/disposable';
-import type { Unsubscribe } from '../core/Unsubscribe';
-import type { Signal } from '../event/Signal';
-import type { AnyRecord } from '../util/type';
-import type { LogTarget } from '../logging/LogTarget';
-export interface Patch<T, EventMap = AnyRecord> extends Disposable {
-    /**
-     * A signal that emits synthetic events.
-     * These events will be dispatched on the proxy, not on the original event target.
-     * If undefined, no events are fabricated.
-     */
-    readonly eventFabricated?: Signal<Event>;
-    /**
-     * Overridden properties.
-     */
-    readonly properties?: PropertyPatches<T>;
-    /**
-     * Overridden events.
-     * Event patches may provide an alternate event to emit, or null to prevent an event from
-     * dispatching on the proxy.
-     *
-     * Note:
-     * Patched events have divergent behavior when using Event.stopImmediatePropagation.
-     * All handlers added to the patched Proxy will still be called after stopImmediatePropagation.
-     * It is the author's opinion that using stopImmediatePropagation is an anti-pattern, and one
-     * handler should not be allowed to influence the behavior of neighboring handlers.
-     */
-    readonly events?: EventPatches<EventMap>;
-}
-/**
- * A record of property key to property patch.
- */
-export type PropertyPatches<T> = {
-    readonly [P in keyof T]?: PropertyPatch<T, P>;
-};
-/**
- * An override to a patched property.
- */
-export interface PropertyPatch<T, K extends keyof T> {
-    /**
-     * @return Returns the value to return on the proxy.
-     */
-    get?(): T[K];
-    /**
-     * @param newValue The property value attempting to be set.
-     */
-    set?(newValue: T[K]): void;
-}
-/**
- * Handles an event emitted from the event target. The returned event will be emitted in its
- * place on the proxy.
- *
- * Fabricated events from `eventFabricated` will not be passed to this handler and cannot be
- * squelched.
- *
- * @param event The original event from the event target. This should not be modified
- * directly, but may be cloned and a modified clone may be returned.
- *
- * @return Returns the event to emit on the proxy or null to squelch the event.
- */
-export type EventPatch<T> = (event: T) => T | null;
-/**
- * A record of event type to an event patch.
- */
-export type EventPatches<EventMap> = {
-    readonly [P in keyof EventMap]?: EventPatch<EventMap[P]>;
-};
-export type PatchFactory<T, EventMap> = (target: T) => Patch<T, EventMap>;
-export interface PatchedRef<T> extends Disposable {
-    /**
-     * The patched target.
-     */
-    readonly patched: T;
-    /**
-     * A signal for when a synthetic event was fabricated.
-     */
-    eventFabricated: Signal<Event>;
-    /**
-     * A signal for when an event was squelched.
-     */
-    eventSquelched: Signal<Event>;
-}
-/**
- * Creates a Proxy for patched event and properties on the target. All patches from the provided
- * factory list will be used in creating a proxy chain. Each patch is applied in order, and
- * patches can rely on their target having been patched with all previous patches.
- *
- * @param target
- * @param patchFactories A list of factories that each produce a new patch for the target.
- * @return Returns a disposable object with a Proxy reference with overridden event and property
- * behavior. When disposed, the event listeners are removed.
- */
-export declare function patchTarget<T extends object, EventMap = AnyRecord>(target: T, ...patchFactories: PatchFactory<T, EventMap>[]): PatchedRef<T>;
-/**
- * Logs debug messages when an event was squelched or fabricated.
- *
- * @param pathTarget
- * @param patched
- * @return Returns a function that when invoked, removes the logging.
- */
-export declare function logPatchedEvents(pathTarget: LogTarget, patched: PatchedRef<any>): Unsubscribe;
-/**
- * A tuple of `[flag, factory]`.
- * Patches will be applied when flag is true.
- */
-export type FlagAndPatchEntry<T extends object, EventMap, Key> = readonly [
-    flagKey: Key,
-    factory: PatchFactory<T, EventMap>
-];
-/**
- * Given a list of [flagKey, patchFactory] tuples, patches the target with patches where flag is true.
- */
-export declare function patchTargetFromFlags<T extends object, EventMap, Flags>(target: T, flags: Flags, ...patchEntries: readonly FlagAndPatchEntry<T, EventMap, keyof Flags>[]): PatchedRef<T>;
-//# sourceMappingURL=patchTarget.d.ts.map

package/dist/types/ts4.7/patch/patchTarget.d.ts

@@ -1,114 +0,0 @@
-import { type Disposable } from '../core/disposable';
-import type { Unsubscribe } from '../core/Unsubscribe';
-import { type Signal } from '../event/Signal';
-import type { AnyRecord } from '../util/type';
-import { type LogTarget } from '../logging/LogTarget';
-export interface Patch<in T, in EventMap = AnyRecord> extends Disposable {
-    /**
-     * A signal that emits synthetic events.
-     * These events will be dispatched on the proxy, not on the original event target.
-     * If undefined, no events are fabricated.
-     */
-    readonly eventFabricated?: Signal<Event>;
-    /**
-     * Overridden properties.
-     */
-    readonly properties?: PropertyPatches<T>;
-    /**
-     * Overridden events.
-     * Event patches may provide an alternate event to emit, or null to prevent an event from
-     * dispatching on the proxy.
-     *
-     * Note:
-     * Patched events have divergent behavior when using Event.stopImmediatePropagation.
-     * All handlers added to the patched Proxy will still be called after stopImmediatePropagation.
-     * It is the author's opinion that using stopImmediatePropagation is an anti-pattern, and one
-     * handler should not be allowed to influence the behavior of neighboring handlers.
-     */
-    readonly events?: EventPatches<EventMap>;
-}
-/**
- * A record of property key to property patch.
- */
-export type PropertyPatches<in T> = {
-    readonly [P in keyof T]?: PropertyPatch<T, P>;
-};
-/**
- * An override to a patched property.
- */
-export interface PropertyPatch<T, K extends keyof T> {
-    /**
-     * @return Returns the value to return on the proxy.
-     */
-    get?(): T[K];
-    /**
-     * @param newValue The property value attempting to be set.
-     */
-    set?(newValue: T[K]): void;
-}
-/**
- * Handles an event emitted from the event target. The returned event will be emitted in its
- * place on the proxy.
- *
- * Fabricated events from `eventFabricated` will not be passed to this handler and cannot be
- * squelched.
- *
- * @param event The original event from the event target. This should not be modified
- * directly, but may be cloned and a modified clone may be returned.
- *
- * @return Returns the event to emit on the proxy or null to squelch the event.
- */
-export type EventPatch<T> = (event: T) => T | null;
-/**
- * A record of event type to an event patch.
- */
-export type EventPatches<in EventMap> = {
-    readonly [P in keyof EventMap]?: EventPatch<EventMap[P]>;
-};
-export type PatchFactory<T, EventMap> = (target: T) => Patch<T, EventMap>;
-export interface PatchedRef<T> extends Disposable {
-    /**
-     * The patched target.
-     */
-    readonly patched: T;
-    /**
-     * A signal for when a synthetic event was fabricated.
-     */
-    eventFabricated: Signal<Event>;
-    /**
-     * A signal for when an event was squelched.
-     */
-    eventSquelched: Signal<Event>;
-}
-/**
- * Creates a Proxy for patched event and properties on the target. All patches from the provided
- * factory list will be used in creating a proxy chain. Each patch is applied in order, and
- * patches can rely on their target having been patched with all previous patches.
- *
- * @param target
- * @param patchFactories A list of factories that each produce a new patch for the target.
- * @return Returns a disposable object with a Proxy reference with overridden event and property
- * behavior. When disposed, the event listeners are removed.
- */
-export declare function patchTarget<T extends object, EventMap = AnyRecord>(target: T, ...patchFactories: PatchFactory<T, EventMap>[]): PatchedRef<T>;
-/**
- * Logs debug messages when an event was squelched or fabricated.
- *
- * @param pathTarget
- * @param patched
- * @return Returns a function that when invoked, removes the logging.
- */
-export declare function logPatchedEvents(pathTarget: LogTarget, patched: PatchedRef<any>): Unsubscribe;
-/**
- * A tuple of `[flag, factory]`.
- * Patches will be applied when flag is true.
- */
-export type FlagAndPatchEntry<T extends object, EventMap, Key> = readonly [
-    flagKey: Key,
-    factory: PatchFactory<T, EventMap>
-];
-/**
- * Given a list of [flagKey, patchFactory] tuples, patches the target with patches where flag is true.
- */
-export declare function patchTargetFromFlags<T extends object, EventMap, Flags>(target: T, flags: Flags, ...patchEntries: readonly FlagAndPatchEntry<T, EventMap, keyof Flags>[]): PatchedRef<T>;
-//# sourceMappingURL=patchTarget.d.ts.map