Usage
@raydeck/serverless-appsync-builder [options] [command]
Options
- -w --working-path <
path
> Working directory for project (default: .
Commands
wrapper
Build wrapper ts file for lambdas
Usage
@raydeck/serverless-appsync-builder wrapper [options]
Options
- -o --output <
outputfile
> Output to write to (default: ./_appsync_wrapper.ts
serverless
Update serverless.yml with data resolvers for appsync
Usage
@raydeck/serverless-appsync-builder serverless [options]
Options
- -y --yamlfile <
path
> Path to serverless.yml file (default: ./serverless.yml
add-serverless-function
Update serverless with appsync function reference
Usage
@raydeck/serverless-appsync-builder add-serverless-function [options]
Options
- -y --yamlfile <
path
> Path to serverless.yml file (default: ./serverless.yml
@raydeck/serverless-appsync-builder - v1.0.9
@raydeck/serverless-appsync-builder - v1.0.9
Index
Interfaces
Functions
- buildServerlessAppsync
- findTemplate
- flatten
- inspect
- makeAppSyncText
- makeAppsyncImports
- makeAppsyncLambda
- makeFieldResolver
- makeMappingTemplate
- makeMappingTemplates
- makeMutationResolver
- makeQueryResolver
- resolveBoolean
- resolveCursor
- withBatch
Functions
buildServerlessAppsync
▸ buildServerlessAppsync(resolvers
: [string, AppsyncResolverWrapper[]][]): object | object
Defined in index.ts:291
Parameters:
Name | Type |
---|---|
resolvers |
[string, AppsyncResolverWrapper[]][] |
Returns: object | object
findTemplate
▸ findTemplate(filename
: string, currentPath
: string): string
Defined in index.ts:125
Parameters:
Name | Type | Default |
---|---|---|
filename |
string | - |
currentPath |
string | process.cwd() |
Returns: string
flatten
▸ flatten(paths
: object[]): AppsyncResolverWrapperFile[]
Defined in index.ts:120
Parameters:
Name | Type |
---|---|
paths |
object[] |
Returns: AppsyncResolverWrapperFile[]
inspect
▸ inspect(exports
: object): AppsyncResolverWrapper[]
Defined in index.ts:81
Parameters:
Name | Type |
---|---|
exports |
object |
Returns: AppsyncResolverWrapper[]
makeAppSyncText
▸ makeAppSyncText(resolvers
: [string, AppsyncResolverWrapper[]][]): string
Defined in index.ts:221
Parameters:
Name | Type |
---|---|
resolvers |
[string, AppsyncResolverWrapper[]][] |
Returns: string
makeAppsyncImports
▸ makeAppsyncImports(resolvers
: [string, AppsyncResolverWrapper[]][]): string
Defined in index.ts:178
Parameters:
Name | Type |
---|---|
resolvers |
[string, AppsyncResolverWrapper[]][] |
Returns: string
makeAppsyncLambda
▸ makeAppsyncLambda(resolvers
: [string, AppsyncResolverWrapper[]][]): string
Defined in index.ts:192
Parameters:
Name | Type |
---|---|
resolvers |
[string, AppsyncResolverWrapper[]][] |
Returns: string
makeFieldResolver
▸ makeFieldResolver‹T›(argsOrFunc
: object | function): FieldResolverOutput‹T›
Defined in index.ts:17
Type parameters:
Parameters:
Name | Type |
---|---|
argsOrFunc |
object | function |
Returns: FieldResolverOutput‹T›
makeMappingTemplate
▸ makeMappingTemplate(template
: AppsyncResolverWrapper, mappingTemplatesPath
: string, path
: string): void
Defined in index.ts:135
Parameters:
Name | Type | Default |
---|---|---|
template |
AppsyncResolverWrapper | - |
mappingTemplatesPath |
string | "mapping-templates" |
path |
string | process.cwd() |
Returns: void
makeMappingTemplates
▸ makeMappingTemplates(resolvers
: AppsyncResolverWrapper[], mappingTemplatesPath
: string, path
: string): void
Defined in index.ts:161
Parameters:
Name | Type | Default |
---|---|---|
resolvers |
AppsyncResolverWrapper[] | - |
mappingTemplatesPath |
string | "mapping-templates" |
path |
string | process.cwd() |
Returns: void
makeMutationResolver
▸ makeMutationResolver‹T›(argsOrFunc
: object | function): FieldResolverOutput‹T›
Defined in index.ts:54
Type parameters:
Parameters:
Name | Type |
---|---|
argsOrFunc |
object | function |
Returns: FieldResolverOutput‹T›
makeQueryResolver
▸ makeQueryResolver‹T›(argsOrFunc
: object | function): FieldResolverOutput‹T›
Defined in index.ts:36
Type parameters:
Parameters:
Name | Type |
---|---|
argsOrFunc |
object | function |
Returns: FieldResolverOutput‹T›
resolveBoolean
▸ resolveBoolean(value
: boolean): Promise‹boolean›
Defined in index.ts:288
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: Promise‹boolean›
resolveCursor
▸ resolveCursor‹ResolverFunc›(arr
: any[], resolver
: ResolverFunc, lastCursor?
: undefined | string, hasNextPage
: boolean, firstCursor?
: undefined | string, hasPreviousPage
: boolean): Promise‹object›
Defined in index.ts:262
Type parameters:
Parameters:
Name | Type | Default |
---|---|---|
arr |
any[] | [] |
resolver |
ResolverFunc | - |
lastCursor? |
undefined | string | - |
hasNextPage |
boolean | false |
firstCursor? |
undefined | string | - |
hasPreviousPage |
boolean | false |
Returns: Promise‹object›
withBatch
▸ withBatch(f
: function): Promise‹(Anonymous function)›
Defined in index.ts:229
Parameters:
▸ (event
: object, ctx?
: any, cb?
: any): Promise‹any›
Parameters:
Name | Type |
---|---|
event |
object |
ctx? |
any |
cb? |
any |
Returns: Promise‹(Anonymous function)›
@raydeck/serverless-appsync-builder - v1.0.9 › AppsyncResolverWrapper
Interface: AppsyncResolverWrapper
Hierarchy
-
AppsyncResolverWrapper
Index
Properties
Properties
field
• field: string
Defined in index.ts:74
func
• func: function
Defined in index.ts:75
Type declaration:
▸ (args
: any): Promise‹any›
Parameters:
Name | Type |
---|---|
args |
any |
key
• key: string
Defined in index.ts:76
type
• type: string
Defined in index.ts:73
@raydeck/serverless-appsync-builder - v1.0.9 › AppsyncResolverWrapperFile
Interface: AppsyncResolverWrapperFile
Hierarchy
-
↳ AppsyncResolverWrapperFile
Index
Properties
Properties
field
• field: string
Inherited from AppsyncResolverWrapper.field
Defined in index.ts:74
func
• func: function
Inherited from AppsyncResolverWrapper.func
Defined in index.ts:75
Type declaration:
▸ (args
: any): Promise‹any›
Parameters:
Name | Type |
---|---|
args |
any |
key
• key: string
Inherited from AppsyncResolverWrapper.key
Defined in index.ts:76
path
• path: string
Defined in index.ts:79
type
• type: string
Inherited from AppsyncResolverWrapper.type
Defined in index.ts:73
@raydeck/serverless-appsync-builder - v1.0.9 › FieldResolverOutput
Interface: FieldResolverOutput ‹T›
Type parameters
Hierarchy
- FieldResolverOutput
Index
Properties
Properties
appSyncResolver
• appSyncResolver: string
Defined in index.ts:15
Optional
field
• field? : undefined | string
Defined in index.ts:13
func
• func: function
Defined in index.ts:14
Type declaration:
▸ (o
: object): Promise‹any›
Parameters:
Name | Type |
---|---|
args |
T |
Optional
type
• type? : undefined | string
Defined in index.ts:12