UNPKG

1.5 kBTypeScriptView Raw
1import { SchemaType } from './parts/Schema';
2import { SortItem } from './Sort';
3import { SerializeOptions, Child } from './StructureNodes';
4import { GenericListBuilder, BuildableGenericList, GenericList, GenericListInput } from './GenericList';
5export interface PartialDocumentList extends BuildableGenericList {
6 options?: DocumentListOptions;
7 schemaTypeName?: string;
8}
9export interface DocumentListInput extends GenericListInput {
10 options: DocumentListOptions;
11}
12export interface DocumentList extends GenericList {
13 options: DocumentListOptions;
14 child: Child;
15 schemaTypeName?: string;
16}
17interface DocumentListOptions {
18 filter: string;
19 params?: {
20 [key: string]: any;
21 };
22 defaultOrdering?: SortItem[];
23}
24export declare class DocumentListBuilder extends GenericListBuilder<PartialDocumentList, DocumentListBuilder> {
25 protected spec: PartialDocumentList;
26 constructor(spec?: DocumentListInput);
27 filter(filter: string): DocumentListBuilder;
28 getFilter(): string | undefined;
29 schemaType(type: SchemaType | string): DocumentListBuilder;
30 getSchemaType(): string | undefined;
31 params(params: {}): DocumentListBuilder;
32 getParams(): {
33 [key: string]: any;
34 } | undefined;
35 defaultOrdering(ordering: SortItem[]): DocumentListBuilder;
36 getDefaultOrdering(): SortItem[] | undefined;
37 serialize(options?: SerializeOptions): DocumentList;
38 clone(withSpec?: PartialDocumentList): DocumentListBuilder;
39}
40export {};