|
| 1 | +/*--------------------------------------------------------------------------------------------- |
| 2 | + * Copyright (c) Gitpod. All rights reserved. |
| 3 | + * Licensed under the MIT License. See License.txt in the project root for license information. |
| 4 | + *--------------------------------------------------------------------------------------------*/ |
| 5 | + |
| 6 | +import { EventEmitter, Event, Disposable } from 'vscode'; |
| 7 | + |
| 8 | +export function filterEvent<T>(event: Event<T>, filter: (e: T) => boolean): Event<T> { |
| 9 | + return (listener, thisArgs = null, disposables?) => event(e => filter(e) && listener.call(thisArgs, e), null, disposables); |
| 10 | +} |
| 11 | + |
| 12 | +/** |
| 13 | + * Given an event, returns another event which only fires once. |
| 14 | + * |
| 15 | + * @param event The event source for the new event. |
| 16 | + */ |
| 17 | +export function onceEvent<T>(event: Event<T>): Event<T> { |
| 18 | + return (listener, thisArgs = null, disposables?) => { |
| 19 | + // we need this, in case the event fires during the listener call |
| 20 | + let didFire = false; |
| 21 | + let result: Disposable | undefined = undefined; |
| 22 | + result = event(e => { |
| 23 | + if (didFire) { |
| 24 | + return; |
| 25 | + } else if (result) { |
| 26 | + result.dispose(); |
| 27 | + } else { |
| 28 | + didFire = true; |
| 29 | + } |
| 30 | + |
| 31 | + return listener.call(thisArgs, e); |
| 32 | + }, null, disposables); |
| 33 | + |
| 34 | + if (didFire) { |
| 35 | + result.dispose(); |
| 36 | + } |
| 37 | + |
| 38 | + return result; |
| 39 | + }; |
| 40 | +} |
| 41 | + |
| 42 | +const passthrough = (value: any, resolve: (value?: any) => void) => resolve(value); |
| 43 | + |
| 44 | +export interface PromiseAdapter<T, U> { |
| 45 | + ( |
| 46 | + value: T, |
| 47 | + resolve: |
| 48 | + (value: U | PromiseLike<U>) => void, |
| 49 | + reject: |
| 50 | + (reason: any) => void |
| 51 | + ): any; |
| 52 | +} |
| 53 | + |
| 54 | +/** |
| 55 | + * Return a promise that resolves with the next emitted event, or with some future |
| 56 | + * event as decided by an adapter. |
| 57 | + * |
| 58 | + * If specified, the adapter is a function that will be called with |
| 59 | + * `(event, resolve, reject)`. It will be called once per event until it resolves or |
| 60 | + * rejects. |
| 61 | + * |
| 62 | + * The default adapter is the passthrough function `(value, resolve) => resolve(value)`. |
| 63 | + * |
| 64 | + * @param event the event |
| 65 | + * @param adapter controls resolution of the returned promise |
| 66 | + * @returns a promise that resolves or rejects as specified by the adapter |
| 67 | + */ |
| 68 | +export function promiseFromEvent<T, U>( |
| 69 | + event: Event<T>, |
| 70 | + adapter: PromiseAdapter<T, U> = passthrough): { promise: Promise<U>; cancel: EventEmitter<void> } { |
| 71 | + let subscription: Disposable; |
| 72 | + let cancel = new EventEmitter<void>(); |
| 73 | + return { |
| 74 | + promise: new Promise<U>((resolve, reject) => { |
| 75 | + cancel.event(_ => reject('Cancelled')); |
| 76 | + subscription = event((value: T) => { |
| 77 | + try { |
| 78 | + Promise.resolve(adapter(value, resolve, reject)) |
| 79 | + .catch(reject); |
| 80 | + } catch (error) { |
| 81 | + reject(error); |
| 82 | + } |
| 83 | + }); |
| 84 | + }).then( |
| 85 | + (result: U) => { |
| 86 | + subscription.dispose(); |
| 87 | + return result; |
| 88 | + }, |
| 89 | + error => { |
| 90 | + subscription.dispose(); |
| 91 | + throw error; |
| 92 | + } |
| 93 | + ), |
| 94 | + cancel |
| 95 | + }; |
| 96 | +} |
| 97 | + |
| 98 | +export function eventToPromise<T>(event: Event<T>): Promise<T> { |
| 99 | + return new Promise(resolve => onceEvent(event)(resolve)); |
| 100 | +} |
0 commit comments