Skip to main content

Class: SstLoader

Load resolvers into an SST AppSyncAPI construct.

import { SstLoader } from '@appsync-butler/sst';
import { Table, AppSyncApi } from '@serverless-stack/resources';

const table = new Table(...);

const api = new AppSyncApi(myStack, "api", {
  dataSources: { myTable: { table } }
});

const loader = new SstLoader(myStack, {
  api,
  defaultUnitResolverDataSource: 'myTable',
  defaultFunctionDataSource: 'none',
  variables: {
    tableName: table.dynamodbTable.tableName
  }
})

Extends​

  • default

Constructors​

new SstLoader()​

new SstLoader(scope, options): SstLoader

Parameters​

scope​

Construct

options​

SstLoaderOptions

Returns​

SstLoader

Overrides​

Loader.constructor

Properties​

api​

protected readonly api: GraphqlApi

The passed API instance.

Inherited from​

Loader.api

builder​

readonly builder: Builder

The underlying builder instance that is responsible for building the resolver tree and function dictionary.

Inherited from​

Loader.builder

dataSources?​

protected readonly optional dataSources: Record<string, BaseDataSource>

Data source dictionary

Inherited from​

Loader.dataSources

defaultFunctionDs?​

readonly optional defaultFunctionDs: string

Inherit Doc​

Overrides​

Loader.defaultFunctionDs

defaultUnitResolverDs?​

readonly optional defaultUnitResolverDs: string

Inherit Doc​

Overrides​

Loader.defaultUnitResolverDs

functions​

readonly functions: Record<string, AppsyncFunction>

The created Appsync Functions. Only populated after loading.

Inherited from​

Loader.functions

noneDs?​

protected optional noneDs: BaseDataSource

None data source object. Created and reused when necessary.

Inherited from​

Loader.noneDs

scope​

protected readonly scope: Construct

The passed scope. Used when creating Appsync Functions

Inherited from​

Loader.scope

sstApi​

protected sstApi: AppSyncApi

Inherit Doc​

Methods​

addFunction()​

protected addFunction(func): void

Parameters​

func​

ParsedFunctionInfo

Returns​

void

Inherited from​

Loader.addFunction

addResolver()​

protected addResolver(resolver): void

http://github.com/serverless-stack/serverless-stack/issues/1115

Parameters​

resolver​

ParsedResolverInfo

Returns​

void

Overrides​

Loader.addResolver

getAppSyncFunction()​

protected getAppSyncFunction(name): AppsyncFunction

Parameters​

name​

string

Returns​

AppsyncFunction

Inherited from​

Loader.getAppSyncFunction

getFunctionDataSource()​

protected getFunctionDataSource(func): string

Parameters​

func​

ParsedFunctionInfo

Returns​

string

Inherited from​

Loader.getFunctionDataSource

getMappingTemplate()​

Call Signature​

protected getMappingTemplate(data): MappingTemplate

Parameters​
data​

string

Returns​

MappingTemplate

Inherited from​

Loader.getMappingTemplate

Call Signature​

protected getMappingTemplate(data): undefined

Parameters​
data​

undefined

Returns​

undefined

Inherited from​

Loader.getMappingTemplate

Call Signature​

protected getMappingTemplate(data): undefined | MappingTemplate

Parameters​
data​

undefined | string

Returns​

undefined | MappingTemplate

Inherited from​

Loader.getMappingTemplate

getNoneDs()​

protected getNoneDs(): BaseDataSource

Returns​

BaseDataSource

Inherited from​

Loader.getNoneDs

getResolverProps()​

protected getResolverProps(resolver): Omit<BaseResolverProps, "fieldName" | "typeName">

Parameters​

resolver​

ParsedResolverInfo

Returns​

Omit<BaseResolverProps, "fieldName" | "typeName">

Inherited from​

Loader.getResolverProps

getUnitResolverDataSource()​

protected getUnitResolverDataSource(resolver): string

Parameters​

resolver​

ParsedUnitResolverInfo

Returns​

string

Inherited from​

Loader.getUnitResolverDataSource

load()​

load(): void

Load on-disk resolvers and functions into AppSync.

Returns​

void

Inherited from​

Loader.load

loadFunctions()​

protected loadFunctions(): void

Returns​

void

Inherited from​

Loader.loadFunctions

loadResolvers()​

protected loadResolvers(): void

Returns​

void

Inherited from​

Loader.loadResolvers

resolveDataSource()​

protected resolveDataSource(ds): BaseDataSource

Parameters​

ds​

DataSource

Returns​

BaseDataSource

Inherited from​

Loader.resolveDataSource

resolveStringDataSource()​

protected resolveStringDataSource(ds): BaseDataSource

Parameters​

ds​

string

Returns​

BaseDataSource

Overrides​

Loader.resolveStringDataSource

throwDataSourceKeyNotFound()​

protected throwDataSourceKeyNotFound(ds): never

Parameters​

ds​

string

Returns​

never

throwNoDefaultFunctionDataSourceFound()​

protected throwNoDefaultFunctionDataSourceFound(noDataSourceFunction): never

Parameters​

noDataSourceFunction​

ParsedFunctionInfo

Returns​

never

Inherited from​

Loader.throwNoDefaultFunctionDataSourceFound

throwNoDefaultUnitDataSourceFound()​

protected throwNoDefaultUnitDataSourceFound(noDataSourceResolver): never

Parameters​

noDataSourceResolver​

ParsedUnitResolverInfo

Returns​

never

Inherited from​

Loader.throwNoDefaultUnitDataSourceFound