Class: Reader

Resolver and function reader.

import { Reader } from 'aws-appsync-butler';
const reader = new Reader();
reader.readTypes(); // ['Query', 'Mutation', 'Post']
reader.readFields('Query'); // ['getPost', 'getAuthor']
const resolver = reader.readResolver('Query', 'getPost');

reader.readFunctions(); // ['getPostById', 'getAuthorByPostId']
const func = reader.readFunction('getPostById');

Hierarchy

• Reader

  ↳ Parser

Constructors

constructor

• new Reader(optionsOrRoot?)

Parameters

Name	Type	Description
optionsOrRoot	string | ReaderOptions	Path to VTL directory or reading directives

Methods

readFunctions

▸ readFunctions(): string[]

Reads the on-disk function directory names. Essentially, the first-level subdirectories of functions are read.

vtl
├── functions
│   └── GetPostById
│       ├── request.vtl
│       └── response.vtl
└── resolvers

reader.readFunctions(); // ['GetPostById']

Returns

string[]

A list of function names

---

readTypes

▸ readTypes(): string[]

Reads the on-disk GraphQL type names. Essentially, the first-level subdirectories of resolvers are read.

vtl
├── functions
└── resolvers
    ├── Mutation
    └── Query
    └── Post

reader.readTypes(); // ['Mutation', 'Query', 'Post']

Returns

string[]

A list of GraphQL types

---

readFields

▸ readFields(typeName): string[]

Reads the on-disk GraphQL field names. Essentially, the second-level subdirectories of resolvers are read.

vtl
├── functions
└── resolvers
    ├── Mutation
    └── Query
        └── getPost
            ├── request.vtl
            └── response.vtl

reader.readFields('Query'); // ['getPost']

Parameters

Name	Type	Description
typeName	string	GraphQL type name

Returns

string[]

A list of GraphQL fields

---

readResolver

▸ readResolver(typeName, fieldName): ResolverInfo

Reads a GraphQL field resolver from disk.

Parameters

Name	Type	Description
typeName	string	GraphQL type name
fieldName	string	GraphQL field name

Returns

ResolverInfo

Unit or Pipeline Resolver information

---

readFunction

▸ readFunction(functionName): FunctionInfo

Reads an AWS AppSync Function from disk.

Parameters

Name	Type	Description
functionName	string	Function name

Returns

FunctionInfo

Function information