Skip to content

Commit

Permalink
docs(api): whitespace changes
Browse files Browse the repository at this point in the history
add multiline params
  • Loading branch information
tusharmath committed Nov 24, 2016
1 parent 07bbff0 commit b2ee784
Showing 1 changed file with 72 additions and 20 deletions.
92 changes: 72 additions & 20 deletions API.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,33 @@
## Sources
```ts
function fromArray<T>(arr: Array<T>): IObservable<T>
function fromArray<T>(
arr: Array<T>
): IObservable<T>
```

```ts
function fromDOM(element: HTMLElement, name: string): IObservable<T>
function fromDOM(
element: HTMLElement,
name: string
): IObservable<T>
```

```ts
function fromPromise<T>((f: () => Promise<T>)): IObservable<T>
function fromPromise<T>(
f: () => Promise<T>
): IObservable<T>
```

```ts
function interval(duration: number): IObservable<T>
function interval(
duration: number
): IObservable<T>
```

```ts
function of(...t: Array<any>): IObservable<any>
function of(
...t: Array<any>
): IObservable<any>
```

```ts
Expand All @@ -26,63 +37,101 @@ function subject(): ISubject<T>

## Operators
```ts
function filter<T>((t: T) => Boolean, s: IObservable<T>): IObservable<T>
function filter<T>(
(t: T) => Boolean,
s: IObservable<T>
): IObservable<T>
```

```ts
function join<T>(s: IObservable<IObservable<T>>): IObservable<T>
function join<T>(
s: IObservable<IObservable<T>>
): IObservable<T>
```

```ts
function map<T, R>(m: (v: T) => R, s: IObservable<T>): IObservable<R>
function map<T, R>(
m: (v: T) => R,
s: IObservable<T>
): IObservable<R>
```

```ts
function merge<T>(...t: Array<IObservable<T>>): IObservable<T>
function merge<T>(...t: Array<IObservable<T>>
): IObservable<T>
```

```ts
function multicast<T>(s: IObservable<T>): IObservable<T>
function multicast<T>(
s: IObservable<T>
): IObservable<T>
```

```ts
function rafThrottle<T>(s: IObservable<T>): IObservable<T>
function rafThrottle<T>(
s: IObservable<T>
): IObservable<T>
```

```ts
function reduce<T, R>(r: (a: R, b: T) => R, v: T, s: IObservable<T>): IObservable<R>
function reduce<T, R>(
r: (a: R, b: T) => R,
v: T, s: IObservable<T>
): IObservable<R>
```

```ts
function sample<T, R> (f: (...e: Array<any>) => R, sampler: IObservable<any>, sources: Array<IObservable<any>>) : IObservable<T>
function sample<T, R> (
f: (...e: Array<any>) => R,
sampler: IObservable<any>,
sources: Array<IObservable<any>>
) : IObservable<T>
```

```ts
function scan<T, R>(r: (a: R, b: T) => R, v: T, s: IObservable<T>): IObservable<R>
function scan<T, R>(
r: (a: R, b: T) => R,
v: T,
s: IObservable<T>
): IObservable<R>
```

```ts
function skipRepeats<T, H>(x: (i: T) => H, s: IObservable<T>): IObservable<T>
function skipRepeats<T, H>(
x: (i: T) => H,
s: IObservable<T>
): IObservable<T>
```

```ts
function slice(start: number, count: number, source: IObservable<T>): IObservable<T>
function slice(
start: number,
count: number,
source: IObservable<T>
): IObservable<T>
```

```ts
function switchLatest<T>(s: IObservable<IObservable<T>>): IObservable<T>
function switchLatest<T>(
s: IObservable<IObservable<T>>
): IObservable<T>
```

```ts
function tap<T>(m: (v: T) => void, s: IObservable<T>): IObservable<T>
function tap<T>(
m: (v: T) => void, s: IObservable<T>
): IObservable<T>
```



## Interfaces
```ts
interface IObservable<T> {
subscribe(observer: IObserver<T>, scheduler: IScheduler): ISubscription
subscribe(
observer: IObserver<T>,
scheduler: IScheduler
): ISubscription
}
```

Expand Down Expand Up @@ -120,7 +169,10 @@ ISubscription {

## Utilities
```ts
function function forEach <T> (onNext: (t: T) => void, source: IObservable<T>): ISubscription
function function forEach <T> (
onNext: (t: T) => void,
source: IObservable<T>
): ISubscription
```


Expand Down

0 comments on commit b2ee784

Please sign in to comment.