subscribe

subscribe

Signature - source.ts#L605

Copyfunction subscribe<T>(
    sink?: Sink<T> | ((event: Event<T>) => void),
): (source: Source<T>) => Sink<T>
1
function subscribe<T>(
2
    sink?: Sink<T> | ((event: Event<T>) => void),
3
): (source: Source<T>) => Sink<T>

Higher order function which takes a sink, and returns another function which receives a source that will be subscribed to using the given sink. This is useful, for example, at the end of pipe calls in order to subscribe to the transformed source.

Parameters

CopySink<T> | ((event: Event<T>) => void)
1
Sink<T> | ((event: Event<T>) => void)

Returns

Copy(source: Source<T>) => Sink<T>
1
(source: Source<T>) => Sink<T>

Example Usage

Copyimport { DogPictures, myGetDogPictures } from './myApi.ts';
import { MyRequestTimeoutError } from './myRequestTimeoutError.ts';
import { myReportError } from './myReportError.ts'
import { myUpdateViewWithDogs } from './myUpdateViewWithDogs.ts'

const sink = Sink<DogPictures>(event => {
    if (event.type === ThrowType) {
        myReportError(event.error)
    } else if (event.type === EndType) {
        return;
    }
    myUpdateViewWithDogs(event.value)
});

pipe(
    myGetDogPictures(...),
    timeoutMs(5000, throwError(() => new MyRequestTimeoutError())),
    retry(3),
    subscribe(sink)
);
1
import { DogPictures, myGetDogPictures } from './myApi.ts';
2
import { MyRequestTimeoutError } from './myRequestTimeoutError.ts';
3
import { myReportError } from './myReportError.ts'
4
import { myUpdateViewWithDogs } from './myUpdateViewWithDogs.ts'
5
6
const sink = Sink<DogPictures>(event => {
7
    if (event.type === ThrowType) {
8
        myReportError(event.error)
9
    } else if (event.type === EndType) {
10
        return;
11
    }
12
    myUpdateViewWithDogs(event.value)
13
});
14
15
pipe(
16
    myGetDogPictures(...),
17
    timeoutMs(5000, throwError(() => new MyRequestTimeoutError())),
18
    retry(3),
19
    subscribe(sink)
20
);

See Also

• Source

• Sink