Class RunbookRepository

Hierarchy

SpaceScopedBasicRepository<Runbook, NewRunbook, RunbookListArgs>
- RunbookRepository

Index

Constructors

Properties

baseApiPathTemplate client spaceName takeAll takeDefaultPageSize

Methods

create del extend get list modify notifySubscribersToDataModifications save subscribeToDataModifications unsubscribeFromDataModifications

Constructors

constructor

new RunbookRepository(client: Client, spaceName: string, project: Project): RunbookRepository
Parameters
- client: Client
- spaceName: string
- project: Project
Returns RunbookRepository
Overrides SpaceScopedBasicRepository.constructor
- Defined in src/features/projects/runbooks/runbookRepository.ts:14

Properties

`Protected` `Readonly` baseApiPathTemplate

baseApiPathTemplate: string

`Protected` client

client: Client

`Protected` `Readonly` spaceName

spaceName: string

`Readonly` takeAll

takeAll: 2147483647 = 2147483647

`Readonly` takeDefaultPageSize

takeDefaultPageSize: 30 = 30

Methods

create

create(resource: NewRunbook, args?: RouteArgs<RouteArgLookup>): Promise<Runbook>
Parameters
- resource: NewRunbook
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<Runbook>
Inherited from SpaceScopedBasicRepository.create
- Defined in src/features/spaceScopedBasicRepository.ts:31

del

del(resource: Runbook): Promise<Runbook>
Parameters
- resource: Runbook
Returns Promise<Runbook>
Inherited from SpaceScopedBasicRepository.del
- Defined in src/features/spaceScopedBasicRepository.ts:25

`Protected` extend

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

get

get(id: string): Promise<Runbook>
Parameters
- id: string
Returns Promise<Runbook>
Inherited from SpaceScopedBasicRepository.get
- Defined in src/features/spaceScopedBasicRepository.ts:36

list

list(args?: RunbookListArgs): Promise<ResourceCollection<Runbook>>
Parameters
- Optional args: RunbookListArgs
Returns Promise<ResourceCollection<Runbook>>
Inherited from SpaceScopedBasicRepository.list
- Defined in src/features/spaceScopedBasicRepository.ts:40

modify

modify(resource: Runbook, args?: RouteArgs<RouteArgLookup>): Promise<Runbook>
Parameters
- resource: Runbook
- Optional args: RouteArgs<RouteArgLookup>
Returns Promise<Runbook>
Inherited from SpaceScopedBasicRepository.modify
- Defined in src/features/spaceScopedBasicRepository.ts:45

`Protected` notifySubscribersToDataModifications

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

save

save(resource: Runbook | NewRunbook): Promise<Runbook>
Parameters
- resource: Runbook | NewRunbook
Returns Promise<Runbook>
Inherited from SpaceScopedBasicRepository.save
- Defined in src/features/basicRepository.ts:61

subscribeToDataModifications

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

unsubscribeFromDataModifications

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

Generated using TypeDoc