File

compodocs/smartedit/services/RestService.ts

Implements

IRestService

Example

Index

Properties
Methods

Constructor

constructor(delegateRestService: DelegateRestService, uri: string, identifier: string)
Parameters :
Name Type Optional
delegateRestService DelegateRestService No
uri string No
identifier string No

Properties

Private metadataActivated
Type : boolean
Default value : false

Methods

activateMetadata
activateMetadata()
Returns : void
get
get(searchParams: Payload, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
searchParams Payload No
options IRestOptions Yes
Returns : Promise<S>
getById
getById(id: string, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
id string No
options IRestOptions Yes
Returns : Promise<S>
page
page(pageable: Pageable, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
pageable Pageable No
options IRestOptions Yes
Returns : Promise<Page<S>>
patch
patch(payload: Payload, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
payload Payload No
options IRestOptions Yes
Returns : Promise<S>
query
query(searchParams: Payload, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
searchParams Payload No
options IRestOptions Yes
Returns : Promise<S[]>
remove
remove(payload: Payload, options?: IRestOptions)
Parameters :
Name Type Optional
payload Payload No
options IRestOptions Yes
Returns : Promise<void>
save
save(payload: Payload, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
payload Payload No
options IRestOptions Yes
Returns : Promise<S>
update
update(payload: Payload, options?: IRestOptions)
Type parameters :
  • S
Parameters :
Name Type Optional
payload Payload No
options IRestOptions Yes
Returns : Promise<S>
import { DelegateRestService } from './DelegateRestServiceInner';
import { IRestOptions, IRestService, Page, Pageable, Payload } from 'smarteditcommons';

/** @internal */
export class RestService<T> implements IRestService<T> {
    private metadataActivated: boolean = false;

    constructor(
        private delegateRestService: DelegateRestService,
        private uri: string,
        private identifier: string
    ) {}

    getById<S extends T = T>(id: string, options?: IRestOptions): Promise<S> {
        return this.delegateRestService.delegateForSingleInstance(
            'getById',
            id,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }
    get<S extends T = T>(searchParams: Payload, options?: IRestOptions): Promise<S> {
        return this.delegateRestService.delegateForSingleInstance(
            'get',
            searchParams,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }
    update<S extends T = T>(payload: Payload, options?: IRestOptions): Promise<S> {
        return this.delegateRestService.delegateForSingleInstance(
            'update',
            payload,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }

    patch<S extends T = T>(payload: Payload, options?: IRestOptions): Promise<S> {
        return this.delegateRestService.delegateForSingleInstance(
            'patch',
            payload,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }

    save<S extends T = T>(payload: Payload, options?: IRestOptions): Promise<S> {
        return this.delegateRestService.delegateForSingleInstance(
            'save',
            payload,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }
    query<S extends T = T>(searchParams: Payload, options?: IRestOptions): Promise<S[]> {
        return this.delegateRestService.delegateForArray(
            'query',
            searchParams,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }
    page<S extends T = T>(pageable: Pageable, options?: IRestOptions): Promise<Page<S>> {
        return this.delegateRestService.delegateForPage<S>(
            pageable,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }
    remove(payload: Payload, options?: IRestOptions): Promise<void> {
        return this.delegateRestService.delegateForSingleInstance(
            'remove',
            payload,
            this.uri,
            this.identifier,
            this.metadataActivated,
            options
        );
    }

    activateMetadata(): void {
        // will activate response headers appending
        this.metadataActivated = true;
    }
}

result-matching ""

    No results matching ""