Version: 0.16.x

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

Index

Constructors

Properties

Methods

Constructors

constructor

+ new GraphbackProxyService(service: GraphbackCRUDService): GraphbackProxyService

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

Parameters:

NameType
serviceGraphbackCRUDService

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:

NameType
relationFieldstring
idstring | number
filterQueryFilter
contextGraphbackContext
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:

NameType
dataType
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:

NameType
dataType
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:

NameType
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:

NameType
argsPartial‹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:

NameType
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:

NameType
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:

NameType
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:

NameType
dataType
context?GraphbackContext
info?GraphQLResolveInfo

Returns: Promise‹Type›