Achieve full API Documentation

[pathurs]

API Documentation

Document each type accessible by a developer, whether directly imported, argument type, or return type.

Each type needs to have the following before being considered done:

1. JSDoc Documentation
   a. summary
   b. @param functions, getters, constructors
   c. @since
   d. @returns functions, setters
   e. @see {@link url/to/online/documentation}
2. Gitbook entry

Rxjs Support

• Summary
• interface NextObserver<T>
• interface ErrorObserver<T>
• interface CompletionObserver<T>
• type PartialObserver<T>
• interface Unsubscribable
• class BehaviourSubject<TData>
  • constructor(protected lastOutput: TData);
  • get value(): TData;
  • getValue(): TData;
  • subscribe(observer: PartialObserver<TData>): Unsubscribable;
  • subscribe(next: ((value: TData) => void) | undefined, error?: (error: any) => void, complete?: () => void ): Unsubscribable;
  • unsubscribe(subscription: Unsubscribable): void;
• class Subscription<T>
  • constructor(public readonly observer: PartialObserver<T>, public readonly unsubscribe: () => void);

Data Sources

• Summary
• class DataSource<TData>
  • constructor(data: TData);
  • set(data: TData): TData;
  • addProcessor(processor: Processor<TData>): TData;
  • removeProcessor(processor: Processor<TData>): TData;
• class TableDataSource<TRow>
  • constructor(array: TRow[]);
  • get filtering(): FilterProcessorApi<TRow>;
  • get sorting(): SorterProcessorApi<TRow>;
  • get paging(): PagerProcessorApi<TRow>;
  • get length(): number;
  • push(...rows: TRow[]): TRow[];
  • remove(row: TRow): TRow[];
  • remove(rows: TRows[]): TRow[];
  • remove(index: number, count?: number): TRow[];

Processors

• Summary
• type SimpleProcessor<TData>
• class ComplexProcessor<TData>
  • constructor(data: TData, active?: boolean);
  • get active(): boolean;
  • set active(active: boolean);
  • process(data: TData, force?: boolean): TData;
  • reprocess(force?: boolean): TData;
• class ArrayProcessor<TEntry>
  • get length(): number;
• type BooleanFilter
• type PropertyFilter<TEntry>
• interface PropertyAndValueFilter<TEntry>
• type FunctionFilter<TEntry>
• type Filter<TEntry>
• class FilterProcessor<TEntry>
  • constructor(active?: boolean);
  • get filter(): Filter<TEntry>;
  • set filter(filter: Filter<TEntry>);
• type BooleanSorter
• type PropertySorter<TEntry>
• type FunctionSorter<TEntry>
• type SingleSorter<TEntry>
• type MultiSorter<TEntry>
• type Sorter<TEntry>
• class SorterProcessor<TEntry>
  • constructor(active?: boolean);
  • get direction(): boolean;
  • set direction(ascending: boolean);
  • get sorter(): Sorter<TEntry> | undefined;
  • set sorter(sorter: Sorter<TEntry> | undefined);
• type Pager<TEntry>
• class PagerProcessor<TEntry>
  • constructor(active?: boolean);
  • get page(): number;
  • set page(page: number);
  • get pageSize(): number;
  • set pageSize(pageSize: number);
• class QueueProcessor<TData>
  • constructor(value: TData, processors?: Processor<TData>[])
  • get length(): number;
  • addProcessor(processor: Processor<TData>, index?: number): TData;
  • removeProcessor(processor: Processor<TData>): TData;
• type Processor<TData>