Class BasicRepository<TExistingResource, TNewResource, TListArgs, TCreateArgs, TModifyArgs>

Type Parameters

TExistingResource extends Resource
TNewResource extends NewResource
TListArgs extends ListArgs & RouteArgs = ListArgs
TCreateArgs extends RouteArgs = RouteArgs
TModifyArgs extends RouteArgs = RouteArgs

Hierarchy

BasicRepository
- SpaceRepository
- SpaceScopedBasicRepository

Index

Constructors

Properties

baseApiPathTemplate client listParametersTemplate subscribersToDataModifications takeAll takeDefaultPageSize

Methods

create del extend get list modify notifySubscribersToDataModifications save subscribeToDataModifications unsubscribeFromDataModifications

Constructors

constructor

new BasicRepository<TExistingResource, TNewResource, TListArgs, TCreateArgs, TModifyArgs>(client: Client, baseApiPathTemplate: string, listParametersTemplate: string): BasicRepository<TExistingResource, TNewResource, TListArgs, TCreateArgs, TModifyArgs>
Type Parameters
- TExistingResource extends Resource
- TNewResource extends NewResource
- TListArgs extends Object = ListArgs
- TCreateArgs extends RouteArgs<RouteArgLookup> = RouteArgs<RouteArgLookup>
- TModifyArgs extends RouteArgs<RouteArgLookup> = RouteArgs<RouteArgLookup>
Parameters
- client: Client
- baseApiPathTemplate: string
- listParametersTemplate: string
Returns BasicRepository<TExistingResource, TNewResource, TListArgs, TCreateArgs, TModifyArgs>
- Defined in src/features/basicRepository.ts:32

Properties

`Protected` `Readonly` baseApiPathTemplate

baseApiPathTemplate: string

`Protected` client

client: Client

`Private` `Readonly` listParametersTemplate

listParametersTemplate: string

`Private` `Readonly` subscribersToDataModifications

subscribersToDataModifications: Dictionary<((data: TExistingResource) => void)>

`Readonly` takeAll

takeAll: 2147483647 = 2147483647

`Readonly` takeDefaultPageSize

takeDefaultPageSize: 30 = 30

Methods

create

create(resource: TNewResource, args?: TCreateArgs): Promise<TExistingResource>
Parameters
- resource: TNewResource
- Optional args: TCreateArgs
Returns Promise<TExistingResource>
- Defined in src/features/basicRepository.ts:43

del

del(resource: TExistingResource): Promise<TExistingResource>
Parameters
- resource: TExistingResource
Returns Promise<TExistingResource>
- Defined in src/features/basicRepository.ts:39

`Protected` extend

extend(arg1: any, arg2: any): any
Parameters
- arg1: any
- arg2: any
Returns any
- Defined in src/features/basicRepository.ts:85

get

get(id: string): Promise<TExistingResource>
Parameters
- id: string
Returns Promise<TExistingResource>
- Defined in src/features/basicRepository.ts:47

list

list(args?: TListArgs): Promise<ResourceCollection<TExistingResource>>
Parameters
- Optional args: TListArgs
Returns Promise<ResourceCollection<TExistingResource>>
- Defined in src/features/basicRepository.ts:51

modify

modify(resource: TExistingResource, args?: TModifyArgs): Promise<TExistingResource>
Parameters
- resource: TExistingResource
- Optional args: TModifyArgs
Returns Promise<TExistingResource>
- Defined in src/features/basicRepository.ts:55

`Protected` notifySubscribersToDataModifications

notifySubscribersToDataModifications(resource: TExistingResource): TExistingResource
Parameters
- resource: TExistingResource
Returns TExistingResource
- Defined in src/features/basicRepository.ts:89

save

save(resource: TExistingResource | TNewResource): Promise<TExistingResource>
Parameters
- resource: TExistingResource | TNewResource
Returns Promise<TExistingResource>
- Defined in src/features/basicRepository.ts:61

subscribeToDataModifications

subscribeToDataModifications(key: string, callback: ((data: TExistingResource) => void)): void
Parameters
- key: string
- callback: ((data: TExistingResource) => void)
  - - (data: TExistingResource): void
    - Parameters
      
      data: TExistingResource
      
      Returns void
Returns void
- Defined in src/features/basicRepository.ts:77

unsubscribeFromDataModifications

unsubscribeFromDataModifications(key: string): void
Parameters
- key: string
Returns void
- Defined in src/features/basicRepository.ts:81

Generated using TypeDoc