Interface Spawn<T>
interface Spawn<T> {
[toStringTag]: string;
always(callback: (() => void)): DeferredPromise<T>;
catch(callback: ((ex: SpawnException, data: T) => void | PromiseLike<void>)): Spawn<T>;
close(): void;
close(problem?: string): void;
done(callback: ((data: T) => void)): DeferredPromise<T>;
fail(callback: ((exc: Error) => void)): DeferredPromise<T>;
finally(onfinally?: null | (() => void)): Promise<T>;
input(message: T, stream?: boolean): DeferredPromise<T>;
progress(callback: ((message: T, cancel: (() => void)) => void)): DeferredPromise<T>;
stream(callback: ((data: T) => void)): DeferredPromise<T>;
then(callback: ((data: T, message: string) => void | PromiseLike<void>)): Spawn<T>;
}
[toStringTag]: string;
always(callback: (() => void)): DeferredPromise<T>;
catch(callback: ((ex: SpawnException, data: T) => void | PromiseLike<void>)): Spawn<T>;
close(): void;
close(problem?: string): void;
done(callback: ((data: T) => void)): DeferredPromise<T>;
fail(callback: ((exc: Error) => void)): DeferredPromise<T>;
finally(onfinally?: null | (() => void)): Promise<T>;
input(message: T, stream?: boolean): DeferredPromise<T>;
progress(callback: ((message: T, cancel: (() => void)) => void)): DeferredPromise<T>;
stream(callback: ((data: T) => void)): DeferredPromise<T>;
then(callback: ((data: T, message: string) => void | PromiseLike<void>)): Spawn<T>;
}
Type Parameters
Hierarchy-Diagram
Legend
interface
public method
Hierarchy (view full)
- DeferredPromise<T>
- Spawn
Properties
Readonly [to
[to
Methods
always
- always(callback: (() => void)): DeferredPromise<T>
Parameters
- callback: (() => void)
- (): void
Returns void
Returns DeferredPromise<T>
- callback: (() => void)
catch
- catch(callback: ((ex: SpawnException, data: T) => void | PromiseLike<void>)): Spawn<T>
Parameters
- callback: ((ex: SpawnException, data: T) => void | PromiseLike<void>)
The callback to execute when the Promise is rejected.
- (ex: SpawnException, data: T): void | PromiseLike<void>
Parameters
- ex: SpawnException
- data: T
Returns void | PromiseLike<void>
Returns Spawn<T>
A Promise for the completion of the callback.
- callback: ((ex: SpawnException, data: T) => void | PromiseLike<void>)
close
done
- done(callback: ((data: T) => void)): DeferredPromise<T>
Returns DeferredPromise<T>
fail
- fail(callback: ((exc: Error) => void)): DeferredPromise<T>
Returns DeferredPromise<T>
finally
- finally(onfinally?: null | (() => void)): Promise<T>
Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.
Parameters
Optionalonfinally: null | (() => void)The callback to execute when the Promise is settled (fulfilled or rejected).
Returns Promise<T>
A Promise for the completion of the callback.
input
- input(message: T, stream?: boolean): DeferredPromise<T>
Parameters
- message: T
Optionalstream: boolean
Returns DeferredPromise<T>
progress
- progress(callback: ((message: T, cancel: (() => void)) => void)): DeferredPromise<T>
Parameters
Returns DeferredPromise<T>
stream
- stream(callback: ((data: T) => void)): DeferredPromise<T>
Returns DeferredPromise<T>
then
- then(callback: ((data: T, message: string) => void | PromiseLike<void>)): Spawn<T>
Attaches callbacks for the resolution and/or rejection of the Promise.
Parameters
- callback: ((data: T, message: string) => void | PromiseLike<void>)
The callback to execute when the Promise is resolved.
- (data: T, message: string): void | PromiseLike<void>
Parameters
- data: T
- message: string
Returns void | PromiseLike<void>
Returns Spawn<T>
A Promise for the completion of which ever callback is executed.
- callback: ((data: T, message: string) => void | PromiseLike<void>)
Attaches a callback for only the rejection of the Promise.