interface IField
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppSync.IField |
![]() | software.amazon.awscdk.services.appsync.IField |
![]() | aws_cdk.aws_appsync.IField |
![]() | @aws-cdk/aws-appsync » IField |
Implemented by
Field
, Graphql
, Resolvable
A Graphql Field.
Properties
Name | Type | Description |
---|---|---|
is | boolean | property determining if this attribute is a list i.e. if true, attribute would be [Type] . |
is | boolean | property determining if this attribute is non-nullable i.e. if true, attribute would be Type! and this attribute must always have a value. |
is | boolean | property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]! and this attribute's list must always have a value. |
type | Type | the type of attribute. |
field | Resolvable | The options to make this field resolvable. |
intermediate | IIntermediate | the intermediate type linked to this attribute (i.e. an interface or an object). |
isList
Type:
boolean
property determining if this attribute is a list i.e. if true, attribute would be [Type]
.
isRequired
Type:
boolean
property determining if this attribute is non-nullable i.e. if true, attribute would be Type!
and this attribute must always have a value.
isRequiredList
Type:
boolean
property determining if this attribute is a non-nullable list i.e. if true, attribute would be [ Type ]!
and this attribute's list must always have a value.
type
Type:
Type
the type of attribute.
fieldOptions?
Type:
Resolvable
(optional, default: not a resolvable field)
The options to make this field resolvable.
intermediateType?
Type:
IIntermediate
(optional, default: no intermediate type)
the intermediate type linked to this attribute (i.e. an interface or an object).
Methods
Name | Description |
---|---|
args | Generate the arguments for this field. |
directives | Generate the directives for this field. |
to | Generate the string for this attribute. |
argsToString()
public argsToString(): string
Returns
string
Generate the arguments for this field.
directivesToString(modes?)
public directivesToString(modes?: AuthorizationType[]): string
Parameters
- modes
Authorization
Type []
— the authorization modes of the graphql api.
Returns
string
Generate the directives for this field.
toString()
public toString(): string
Returns
string
Generate the string for this attribute.