GraphbackProxyService

ProxyService that can be used by any services that wish to extend Graphback functionality. Service works by proxying method requests to another service or datastore.

Type parameters

▪ Type

Hierarchy

• GraphbackProxyService

Implements

• GraphbackCRUDService‹Type›

Index

Constructors

• constructor

Properties

• proxiedService

Methods

• batchLoadData
• create
• delete
• findBy
• findOne
• subscribeToCreate
• subscribeToDelete
• subscribeToUpdate
• update

Constructors

constructor

+ new GraphbackProxyService(service: GraphbackCRUDService): GraphbackProxyService

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:14

Parameters:

Name	Type
service	GraphbackCRUDService

Returns: GraphbackProxyService

Properties

Protected proxiedService

• proxiedService: GraphbackCRUDService

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:14

Methods

batchLoadData

▸ batchLoadData(relationField: string, id: string | number, filter: QueryFilter, context: GraphbackContext, info?: GraphQLResolveInfo): any

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:52

Parameters:

Name	Type
relationField	string
id	string | number
filter	QueryFilter
context	GraphbackContext
info?	GraphQLResolveInfo

Returns: any

---

create

▸ create(data: Type, context?: GraphbackContext, info?: GraphQLResolveInfo): Promise‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:20

Parameters:

Name	Type
data	Type
context?	GraphbackContext
info?	GraphQLResolveInfo

Returns: Promise‹Type›

---

delete

▸ delete(data: Type, context?: GraphbackContext, info?: GraphQLResolveInfo): Promise‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:28

Parameters:

Name	Type
data	Type
context?	GraphbackContext
info?	GraphQLResolveInfo

Returns: Promise‹Type›

---

findBy

▸ findBy(args?: FindByArgs, context?: GraphbackContext, info?: GraphQLResolveInfo, path?: string): Promise‹ResultList‹Type››

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:36

Parameters:

Name	Type
args?	FindByArgs
context?	GraphbackContext
info?	GraphQLResolveInfo
path?	string

Returns: Promise‹ResultList‹Type››

---

findOne

▸ findOne(args: Partial‹Type›, context?: GraphbackContext, info?: GraphQLResolveInfo): Promise‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:32

Parameters:

Name	Type
args	Partial‹Type›
context?	GraphbackContext
info?	GraphQLResolveInfo

Returns: Promise‹Type›

---

subscribeToCreate

▸ subscribeToCreate(filter?: QueryFilter, context?: GraphbackContext): AsyncIterator‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:40

Parameters:

Name	Type
filter?	QueryFilter
context?	GraphbackContext

Returns: AsyncIterator‹Type›

---

subscribeToDelete

▸ subscribeToDelete(filter?: QueryFilter, context?: GraphbackContext): AsyncIterator‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:48

Parameters:

Name	Type
filter?	QueryFilter
context?	GraphbackContext

Returns: AsyncIterator‹Type›

---

subscribeToUpdate

▸ subscribeToUpdate(filter?: QueryFilter, context?: GraphbackContext): AsyncIterator‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:44

Parameters:

Name	Type
filter?	QueryFilter
context?	GraphbackContext

Returns: AsyncIterator‹Type›

---

update

▸ update(data: Type, context?: GraphbackContext, info?: GraphQLResolveInfo): Promise‹Type›

Defined in packages/graphback-core/src/runtime/GraphbackProxyService.ts:24

Parameters:

Name	Type
data	Type
context?	GraphbackContext
info?	GraphQLResolveInfo

Returns: Promise‹Type›