ngx-hal
Version:
Angular library for supporting HAL format APIs
32 lines (31 loc) • 1.55 kB
TypeScript
import { HttpResponse } from '@angular/common/http';
import { Observable } from 'rxjs';
import { RawHalResource } from '../interfaces/raw-hal-resource.interface';
import { HalModel } from '../models/hal.model';
import { Pagination } from './pagination';
import { ModelConstructor } from '../types/model-constructor.type';
import { DatastoreService } from '../services/datastore/datastore.service';
import { RawHalLink } from '../interfaces/raw-hal-link.interface';
import { RequestOptions } from '../types/request-options.type';
import { RelationshipRequestDescriptor } from '../types/relationship-request-descriptor.type';
export declare class HalDocument<T extends HalModel> {
private rawResource;
private rawResponse;
private modelClass;
private datastore;
models: Array<T>;
pagination: Pagination;
uniqueModelIdentificator: string;
constructor(rawResource: RawHalResource, rawResponse: HttpResponse<any>, modelClass: ModelConstructor<T>, datastore: DatastoreService);
get hasEmbeddedItems(): boolean;
get itemLinks(): Array<RawHalLink>;
getPage(pageNumber: number, includeRelationships?: Array<string | RelationshipRequestDescriptor>, requestOptions?: RequestOptions, subsequentRequestsOptions?: RequestOptions): Observable<HalDocument<T>>;
private parseRawResources;
private generateModels;
private generatePagination;
private getRawResourcesFromResponse;
private getListPropertyName;
get selfLink(): string;
private get links();
private generateUniqueModelIdentificator;
}