@aws-amplify/graphql-directives
Version:
Directive definitions for Amplify GraphQL transformers.
173 lines (121 loc) • 4.22 kB
Markdown
## API Report File for "@aws-amplify/graphql-directives"
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
// @public (undocumented)
export const AppSyncDirectives: readonly Directive[];
// @public (undocumented)
export const AuthDirective: Directive;
// @public (undocumented)
export const AuthDirectiveV1: Directive;
// @public (undocumented)
export const AwsApiKeyDirective: Directive;
// @public (undocumented)
export const AwsAuthDirective: Directive;
// @public (undocumented)
export const AwsCognitoUserPoolsDirective: Directive;
// @public (undocumented)
export const AwsIamDirective: Directive;
// @public (undocumented)
export const AwsLambdaDirective: Directive;
// @public (undocumented)
export const AwsOidcDirective: Directive;
// @public (undocumented)
export const AwsSubscribeDirective: Directive;
// @public (undocumented)
export const BelongsToDirective: Directive;
// @public (undocumented)
export const ConnectionDirectiveV1: Directive;
// @public (undocumented)
export const ConversationDirective: Directive;
// @public (undocumented)
export const DefaultDirective: Directive;
// @public (undocumented)
export const DefaultDirectives: readonly Directive[];
// @public (undocumented)
export const DeprecatedDirective: Directive;
// @public (undocumented)
export interface Directive<Defaults extends DirectiveDefaults = DirectiveDefaults> {
// (undocumented)
readonly defaults: Defaults;
// (undocumented)
readonly definition: string;
// (undocumented)
readonly name: string;
}
// @public (undocumented)
export interface DirectiveDefaults {
}
// @public (undocumented)
export const FunctionDirective: Directive<FunctionDirectiveDefaults>;
// @public (undocumented)
export type FunctionDirectiveDefaults = {
invocationType: string;
};
// @public (undocumented)
export const FunctionDirectiveV1: Directive;
// @public (undocumented)
export const GenerationDirective: Directive;
// @public (undocumented)
export const HasManyDirective: Directive<HasManyDirectiveDefaults>;
// @public (undocumented)
export type HasManyDirectiveDefaults = {
limit: number;
};
// @public (undocumented)
export const HasOneDirective: Directive;
// @public (undocumented)
export const HttpDirective: Directive<HttpDirectiveDefaults>;
// @public (undocumented)
export type HttpDirectiveDefaults = {
method: string;
headers: string[];
};
// Warning: (ae-forgotten-export) The symbol "HttpDirectiveV1Defaults" needs to be exported by the entry point index.d.ts
//
// @public (undocumented)
export const HttpDirectiveV1: Directive<HttpDirectiveV1Defaults>;
// @public (undocumented)
export const IndexDirective: Directive;
// @public (undocumented)
export const KeyDirectiveV1: Directive;
// @public (undocumented)
export const ManyToManyDirective: Directive<ManyToManyDirectiveDefaults>;
// @public (undocumented)
export type ManyToManyDirectiveDefaults = {
limit: number;
};
// @public (undocumented)
export const MapsToDirective: Directive;
// @public (undocumented)
export const ModelDirective: Directive;
// @public (undocumented)
export const ModelDirectiveV1: Directive;
// @public (undocumented)
export const PredictionsDirective: Directive;
// @public (undocumented)
export const PredictionsDirectiveV1: Directive;
// @public (undocumented)
export const PrimaryKeyDirective: Directive;
// @public (undocumented)
export const RefersToDirective: Directive;
// @public (undocumented)
export const SearchableDirective: Directive;
// @public (undocumented)
export const SearchableDirectiveV1: Directive;
// @public (undocumented)
export const SqlDirective: Directive;
// @public (undocumented)
export const V1Directives: readonly Directive[];
// @public (undocumented)
export const V2Directives: readonly Directive[];
// @public (undocumented)
export const ValidateDirective: Directive;
// @public (undocumented)
export const VersionedDirectiveV1: Directive<VersionedDirectiveV1Defaults>;
// @public (undocumented)
export type VersionedDirectiveV1Defaults = {
versionField: string;
versionInput: string;
};
// (No @packageDocumentation comment for this package)
```