Type aliases
AWSAppSyncRealTimeAuthInput
AWSLexProviderSendResponse
AWSLexV2ProviderSendResponse
AbortMultipartUploadInput
ActionMap
ActionMap: object
Alignment
Alignment: object[keyof typeof Alignment]
AllFieldOperators
AllFieldOperators: keyof AllOperators
AmazonLocationServiceBatchGeofenceError
Amazon
LocationServiceBatchGeofenceError: Omit<GeofenceError, "error"> & object
AmazonLocationServiceBatchGeofenceErrorMessages
AmazonLocationServiceBatchGeofenceErrorMessages: "AccessDeniedException" | "InternalServerException" | "ResourceNotFoundException" | "ThrottlingException" | "ValidationException"
AmazonLocationServiceDeleteGeofencesResults
AmazonLocationServiceGeofence
Amazon
LocationServiceGeofence: Omit<Geofence, "status"> & object
AmazonLocationServiceGeofenceOptions
AmazonLocationServiceGeofenceStatus
AmazonLocationServiceGeofenceStatus: "ACTIVE" | "PENDING" | "FAILED" | "DELETED" | "DELETING"
AmazonLocationServiceListGeofenceOptions
AmplifyContext
AmplifyContext: object
Type declaration
-
Auth: typeof Auth
-
Cache: typeof Cache
-
InternalAPI: typeof InternalAPI
AmplifyThemeType
Amplify
ThemeType: Record<string, any>
ApiInfo
ApiInfo: object
Type declaration
-
Optional custom_header?: function
-
endpoint: string
-
Optional region?: string
-
Optional service?: string
ArchiveStatus
ArchiveStatus: object[keyof typeof ArchiveStatus]
ArrayOperators
ArrayOperators: object
Type declaration
-
contains: T
-
notContains: T
AssociatedWith
AssociatedWith: object
Type declaration
-
associatedWith: string | string[]
-
connectionType: "HAS_MANY" | "HAS_ONE"
-
Optional targetName?: string
-
Optional targetNames?: string[]
AttributeType
AttributeType: object[keyof typeof AttributeType]
AuthErrorMessages
AuthErrorMessages: object
AuthModeStrategy
AuthModeStrategy: function
AuthModeStrategyParams
AuthModeStrategyParams: object
AuthModeStrategyReturn
AuthModeStrategyReturn: GRAPHQL_AUTH_MODE | GRAPHQL_AUTH_MODE[] | undefined | null
AuthProviders
AuthProviders: object
Type declaration
-
functionAuthProvider: function
AuthorizationInfo
AuthorizationInfo: object
Type declaration
-
authMode: GRAPHQL_AUTH_MODE
-
isOwner: boolean
-
Optional ownerField?: string
-
Optional ownerValue?: string
AuthorizationRule
AuthorizationRule: object
Type declaration
-
areSubscriptionsPublic: boolean
-
authStrategy: "owner" | "groups" | "private" | "public"
-
groupClaim: string
-
groups: [string]
-
groupsField: string
-
identityClaim: string
-
ownerField: string
-
provider: "userPools" | "oidc" | "iam" | "apiKey"
BoundingBox
Optional height
height: Number
Optional left
left: Number
Optional width
width: Number
ButtonAction
ButtonAction: object[keyof typeof ButtonAction]
ChannelType
ChannelType: "ADM" | "APNS" | "APNS_SANDBOX" | "APNS_VOIP" | "APNS_VOIP_SANDBOX" | "BAIDU" | "CUSTOM" | "EMAIL" | "GCM" | "IN_APP" | "PUSH" | "SMS" | "VOICE"
ChecksumAlgorithm
ChecksumAlgorithm: object[keyof typeof ChecksumAlgorithm]
ChecksumMode
ChecksumMode: object[keyof typeof ChecksumMode]
ClientMetaData
ClientMetaData: object | undefined
CommonStorageOptions
Common
StorageOptions: Omit<StorageOptions, "credentials" | "region" | "bucket" | "dangerouslyConnectToHttpEndpointForTesting">
CompatibleHttpResponse
CompatibleHttpResponse: Omit<HttpResponse, "body"> & object
CompleteMultipartUploadInput
Complete
MultipartUploadInput: Pick<CompleteMultipartUploadCommandInput, "Bucket" | "Key" | "UploadId" | "MultipartUpload" | "SSECustomerAlgorithm" | "SSECustomerKey" | "SSECustomerKeyMD5">
ConditionProducer
ConditionProducer: function
Type declaration
-
- (...args: A): A["length"] extends keyof Lookup<T> ? Lookup<T>[A["length"]] : never
-
Parameters
Returns A["length"] extends keyof Lookup<T> ? Lookup<T>[A["length"]] : never
Config
Config: object
Type declaration
-
[key: string]: string | number
ConfiguredMiddleware
ConfiguredMiddleware: function
ConflictHandler
ConflictHandler: function
ConnectionStatus
ConnectionStatus: object
ControlMessageType
ControlMessageType: object
Type declaration
-
Optional data?: any
-
type: T
CopyObjectInput
Copy
ObjectInput: Pick<CopyObjectCommandInput, "Bucket" | "CopySource" | "Key" | "MetadataDirective" | "CacheControl" | "ContentType" | "ContentDisposition" | "ContentLanguage" | "Expires" | "ACL" | "ServerSideEncryption" | "SSECustomerAlgorithm" | "SSECustomerKey" | "SSECustomerKeyMD5" | "SSEKMSKeyId" | "Tagging" | "Metadata">
CreateMultipartUploadInput
CustomPrefix
CustomPrefix: object
CustomUserAgentDetailsBase
CustomUserAgentDetailsBase: object
DailyInAppMessageCounter
DailyInAppMessageCounter: object
Type declaration
-
count: number
-
lastCountTimestamp: string
DataObject
DataObject: object
DataPayload
DataPayload: object
DataStoreConfig
DataStoreConfig: object
Type declaration
-
Optional DataStore?: object
-
-
-
-
Optional errorHandler?: function
-
Optional fullSyncInterval?: number
-
Optional maxRecordsToSync?: number
-
Optional storageAdapter?: Adapter
-
Optional syncExpressions?: SyncExpression[]
-
Optional syncPageSize?: number
-
-
-
-
Optional errorHandler?: function
-
Optional fullSyncInterval?: number
-
Optional maxRecordsToSync?: number
-
Optional storageAdapter?: Adapter
-
Optional syncExpressions?: SyncExpression[]
-
Optional syncPageSize?: number
DataStoreSnapshot
DataStoreSnapshot: object
Type declaration
-
isSynced: boolean
-
items: T[]
DeepWritable
DeepWritable: object
DefaultPersistentModelMetaData
DefaultPersistentModelMetaData: object
DeferredCallbackResolverOptions
DeferredCallbackResolverOptions: object
Type declaration
-
callback: function
-
Optional errorHandler?: function
-
Optional maxInterval?: number
DeleteGeofencesResults
DeleteGeofencesResults: object
DimensionType
DimensionType: object[keyof typeof DimensionType]
EncodingType
EncodingType: object[keyof typeof EncodingType]
EndpointFailureData
EndpointFailureData: object
Type declaration
-
-
err: any
-
update_params: any
EndpointResolverOptions
EndpointResolverOptions: object
EnumFieldType
EnumFieldType: object
EqualityOperators
EqualityOperators: object
ErrorHandler
ErrorHandler: function
ErrorMap
ErrorMap: Partial<object>
ErrorParser
ErrorParser: function
Type declaration
-
-
Parameters
Returns Promise<Error & MetadataBearer | undefined>
ErrorType
ErrorType: "ConfigError" | "BadModel" | "BadRecord" | "Unauthorized" | "Transient" | "Unknown"
Event
Event: object
Type declaration
-
attributes: string
-
eventId: string
-
immediate: boolean
-
metrics: string
-
name: string
-
session: object
Optional AppPackageName
AppPackageName: string
Optional AppTitle
AppTitle: string
Optional AppVersionCode
AppVersionCode: string
Optional Attributes
Attributes
: Record<string, string>
Optional ClientSdkVersion
ClientSdkVersion: string
EventType
EventType: string | undefined
Optional Metrics
Metrics
: Record<string, number>
Optional SdkName
SdkName: string
Timestamp
Timestamp: string | undefined
EventConfig
EventConfig: object
Type declaration
-
appId: string
-
endpointId: string
-
region: string
-
resendLimit: number
EventMap
EventMap: object
EventObject
EventObject: object
EventParams
EventParams: object
Type declaration
-
-
credentials: object
-
-
resendLimit: number
-
timestamp: string
EventsBufferConfig
EventsBufferConfig: object
Type declaration
-
bufferSize: number
-
flushInterval: number
-
flushSize: number
-
resendLimit: number
FeatureType
FeatureType: "TABLES" | "FORMS" | string
FederatedSignInOptions
FederatedSignInOptions: object
Type declaration
-
Optional customState?: string
-
FederatedSignInOptionsCustom
FederatedSignInOptionsCustom: object
Type declaration
-
customProvider: string
-
Optional customState?: string
FieldAssociation
FieldAssociation: object
Type declaration
-
connectionType: "HAS_ONE" | "BELONGS_TO" | "HAS_MANY"
FilterType
FilterType: object[keyof typeof FilterType]
GeofenceBase
GeofenceBase: object
Type declaration
-
Optional createTime?: Date
-
-
Optional updateTime?: Date
GeofenceError
GeofenceError: object
Type declaration
-
error: object
-
code: string
-
message: string
-
GeofenceId
GeofenceId: string
GeofenceInput
GeofenceInput: object
GeofenceOptions
GeofenceOptions: object
Type declaration
-
Optional providerName?: string
GetObjectInput
Get
ObjectInput: Pick<GetObjectCommandInput, "Bucket" | "Key" | "ResponseCacheControl" | "ResponseContentDisposition" | "ResponseContentEncoding" | "ResponseContentLanguage" | "ResponseContentType" | "SSECustomerAlgorithm" | "SSECustomerKey" | "SSECustomerKeyMD5">
GraphQLField
GraphQLField: object
Type declaration
-
[field: string]: object
-
[operator: string]: string | number | [number, number]
GraphQLFilter
GraphQLFilter
: Partial<GraphQLField | object | object | object>
GraphQLOperation
GraphQLOperation: Source | string
GraphQLQuery
GraphQLQuery: T & object
GraphQLSubscription
GraphQLSubscription: T & object
GraphqlAuthModes
GraphqlAuthModes: keyof typeof GRAPHQL_AUTH_MODE
GroupOperator
GroupOperator: "and" | "or" | "not"
HeadObjectInput
Head
ObjectInput: Pick<HeadObjectCommandInput, "Bucket" | "Key" | "SSECustomerKey" | "SSECustomerKeyMD5" | "SSECustomerAlgorithm">
Headers
Headers
: Record<string, string>
HubCallback
HubCallback: function
HubCapsule
HubCapsule: object
Type declaration
-
channel: string
-
Optional patternInfo?: string[]
-
-
source: string
HubPayload
HubPayload: object
Type declaration
-
Optional data?: any
-
event: string
-
Optional message?: string
IdentifierBrand
IdentifierBrand: T & object
IdentifierFieldOrIdentifierObject
IdentifierFieldValue
IdentifierFieldValue: MetadataOrDefault<T, M>["identifier"] extends CompositeIdentifier<T, any> ? MetadataOrDefault<T, M>["identifier"]["fields"] extends [any] ? T[MetadataOrDefault<T, M>["identifier"]["fields"][0]] : never : T[MetadataOrDefault<T, M>["identifier"]["field"]]
IdentifierFields
IdentifierFields: string
IdentifierFieldsForInit
IdentifierFieldsForInit: MetadataOrDefault<T, M>["identifier"] extends DefaultPersistentModelMetaData | ManagedIdentifier<T, any> ? never : MetadataOrDefault<T, M>["identifier"] extends OptionallyManagedIdentifier<T, any> ? IdentifierFields<T, M> : MetadataOrDefault<T, M>["identifier"] extends CompositeIdentifier<T, any> ? IdentifierFields<T, M> : never
ImageBlob
Image
Blob: Buffer | Uint8Array | Blob | string
InAppMessageAction
InAppMessageAction: "CLOSE" | "DEEP_LINK" | "LINK"
InAppMessageConflictHandler
InAppMessageConflictHandler: function
Type declaration
-
- (messages: InAppMessage[]): InAppMessage
-
Parameters
Returns InAppMessage
InAppMessageCountMap
In
AppMessageCountMap: Record<string, number>
InAppMessageCounts
InAppMessageCounts: object
Type declaration
-
dailyCount: number
-
sessionCount: number
-
totalCount: number
InAppMessageLayout
InAppMessageLayout: "BOTTOM_BANNER" | "CAROUSEL" | "FULL_SCREEN" | "MIDDLE_BANNER" | "MODAL" | "TOP_BANNER"
InAppMessageTextAlign
InAppMessageTextAlign: "center" | "left" | "right"
InAppMessagingEvent
InAppMessagingEvent: object
Type declaration
-
Optional attributes?: Record<string, string>
-
Optional metrics?: Record<string, number>
-
name: string
IndexOptions
IndexOptions: object
Type declaration
-
Optional unique?: boolean
IndexesType
IndexesType: Array<[string, string[], object]>
InferInstructionResultType
InferInstructionResultType: undefined
InferOptionTypeFromTransferHandler
InferOptionTypeFromTransferHandler: Parameters<T>[1]
InteractionsResponse
InteractionsResponse: object
InteractionsTextMessage
InteractionsTextMessage: object
Type declaration
-
content: string
-
options: object
InteractionsVoiceMessage
InteractionsVoiceMessage: object
Type declaration
-
content: object
-
options: object
InternalSchema
InternalSchema: object
Type declaration
-
codegenVersion: string
-
-
version: string
InternalSubscriptionMessage
InternalSubscriptionMessage: object
Type declaration
-
-
element: T
-
-
-
Optional savedElement?: T
JobEntry
JobEntry: object
Type declaration
-
Optional description?: string
-
-
terminate: function
KeyType
KeyType: object
Type declaration
-
Optional compositeKeys?: Set<string>[]
-
Optional primaryKey?: string[]
KeysOfSuperType
KeysOfSuperType: object[keyof T]
KeysOfType
KeysOfType: object[keyof T]
KnownOS
KnownOS: "windows" | "macos" | "unix" | "linux" | "ios" | "android" | "web"
Last
Last: T[Exclude<keyof T, keyof Tail<T>>]
LastParameter
Last
Parameter: Last<Parameters<F>>
Latitude
Latitude: number
Layout
Layout: object[keyof typeof Layout]
LegacyCallback
LegacyCallback: object
LegacyProvider
LegacyProvider: "google" | "facebook" | "amazon" | "developer" | string
LinkedConnectionState
LinkedConnectionState: "connected" | "disconnected"
LinkedConnectionStates
LinkedConnectionStates: object
LinkedHealthState
LinkedHealthState: "healthy" | "unhealthy"
ListGeofenceResults
ListGeofenceResults: object
Type declaration
-
-
nextToken: string | undefined
ListObjectsCommandOutputContent
List
ObjectsCommandOutputContent: _Object
ListPartsInput
List
PartsInput: Pick<ListPartsCommandInput, "Bucket" | "Key" | "UploadId" | "SSECustomerAlgorithm" | "SSECustomerKey" | "SSECustomerKeyMD5">
Longitude
Longitude: number
MapEntry
MapEntry: [string, RegExp, string]
MapTypeToOperands
MapTypeToOperands: object
MatchableTypes
MatchableTypes: string | string[] | number | number[] | boolean | boolean[]
MergeNoConflictKeys
MergeNoConflictKeys: Options extends [infer OnlyOption] ? OnlyOption : Options extends [infer FirstOption, infer SecondOption] ? FirstOption & SecondOption : Options extends [infer FirstOption, any] ? FirstOption & MergeNoConflictKeys<RestOptions> : never
MetadataDirective
MetadataDirective: object[keyof typeof MetadataDirective]
MetadataOrDefault
MetadataOrDefault: T extends object ? T[typeof __modelMeta__] : DefaultPersistentModelMetaData
MetadataReadOnlyFields
MetadataReadOnlyFields: Extract<MetadataOrDefault<T, M>["readOnlyFields"] | M["readOnlyFields"], keyof T>
MetricsComparator
MetricsComparator: function
Type declaration
-
- (metricsVal: number, eventVal: number): boolean
-
Parameters
-
metricsVal: number
-
eventVal: number
Returns boolean
Middleware
Middleware: function
Type declaration
-
-
Parameters
-
options: MiddlewareOptions
MiddlewareContext
MiddlewareContext: object
Type declaration
-
Optional attemptsCount?: number
MiddlewareHandler
MiddlewareHandler: function
ModelAttribute
ModelAttribute: object
Type declaration
-
Optional properties?: Record<string, any>
-
type: string
ModelAttributeAuth
ModelAttributeAuth: object
Type declaration
-
properties: object
-
type: "auth"
ModelAttributeAuthProperty
ModelAttributeAuthProperty: object
Type declaration
-
-
Optional groupClaim?: string
-
Optional groups?: string[]
-
Optional identityClaim?: string
-
Optional operations?: string[]
-
Optional ownerField?: string
-
ModelAttributeCompositeKey
ModelAttributeCompositeKey: object
Type declaration
-
properties: object
-
fields: [string, string, string, string, string]
-
name: string
-
type: "key"
ModelAttributeKey
ModelAttributeKey: object
Type declaration
-
properties: object
-
fields: string[]
-
Optional name?: string
-
type: "key"
ModelAttributePrimaryKey
ModelAttributePrimaryKey: object
Type declaration
-
properties: object
-
fields: string[]
-
name: never
-
type: "key"
ModelAuthModes
Model
AuthModes: Record<string, object>
ModelAuthRule
ModelAuthRule: object
Type declaration
-
allow: string
-
Optional groupClaim?: string
-
Optional groups?: string[]
-
Optional groupsField?: string
-
Optional identityClaim?: string
-
Optional operations?: string[]
-
Optional ownerField?: string
-
Optional provider?: string
ModelField
ModelField: object
Type declaration
-
-
-
isArray: boolean
-
Optional isArrayNullable?: boolean
-
Optional isReadOnly?: boolean
-
Optional isRequired?: boolean
-
name: string
-
type: keyof Omit<typeof GraphQLScalarType, "getJSType" | "getValidationFunction"> | ModelFieldType | NonModelFieldType | EnumFieldType
ModelFieldType
ModelFieldType: object
ModelInit
ModelInit: object & object
ModelInstanceCreator
ModelInstanceCreator: typeof modelInstanceCreator
ModelInstanceMetadata
ModelInstanceMetadata: object
Type declaration
-
_deleted: boolean
-
_lastChangedAt: number
-
_version: number
ModelInstanceMetadataWithId
ModelKeys
ModelKeys: object
ModelMeta
ModelMeta: object
ModelPredicateAggregateExtender
ModelPredicateAggregateExtender: function
ModelPredicateExtender
ModelPredicateExtender: function
ModelPredicateNegation
ModelPredicateNegation: function
ModelPredicateOperator
ModelPredicateOperator: function
MutationProcessorEvent
MutationProcessorEvent: object
NamespaceResolver
NamespaceResolver: function
Type declaration
-
-
Parameters
Returns string
NetworkStatus
NetworkStatus: object
NonModelFieldType
NonModelFieldType: object
NonModelTypeConstructor
NonModelTypeConstructor: object
NonNeverKeys
NonNeverKeys: object[keyof T]
NotificationsCategory
NotificationsCategory: "Notifications"
NotificationsSubCategory
NotificationsSubCategory: "InAppMessaging" | "PushNotification"
ObjectCannedACL
ObjectCannedACL: object[keyof typeof ObjectCannedACL]
ObjectLockLegalHoldStatus
ObjectLockLegalHoldStatus: object[keyof typeof ObjectLockLegalHoldStatus]
ObjectLockMode
ObjectLockMode: object[keyof typeof ObjectLockMode]
ObjectStorageClass
ObjectStorageClass: object[keyof typeof ObjectStorageClass]
ObserverQuery
ObserverQuery: object
Type declaration
-
-
query: string
-
Optional startAckTimeoutId?: ReturnType<typeof setTimeout>
-
Optional subscriptionFailedCallback?: Function
-
Optional subscriptionReadyCallback?: Function
-
-
variables: Record<string, unknown>
OnMessageInteractionEventHandler
OnMessageInteractionEventHandler: function
Type declaration
-
- (message: InAppMessage): any
OnPushNotificationMessageHandler
OnPushNotificationMessageHandler: function
OnTokenReceivedHandler
OnTokenReceivedHandler: function
OptionToMiddleware
OptionToMiddleware: Options extends [] ? [] : Options extends [infer LastOption] ? [Middleware<Request, Response, LastOption>] : Options extends [infer FirstOption, any] ? [Middleware<Request, Response, FirstOption>, any] : never
OptionalizeKey
OptionalizeKey: Omit<T, K & keyof T> & object
OptionallyManagedIdentifier
Optionally
ManagedIdentifier: IdentifierBrand<object, "OptionallyManagedIdentifier">
PaginationInput
PaginationInput: object
Type declaration
-
Optional limit?: number
-
Optional page?: number
-
ParameterizedStatement
ParameterizedStatement: [string, any[]]
ParsedMessagePayload
ParsedMessagePayload: object
Type declaration
-
payload: object
-
connectionTimeoutMs: number
-
Optional errors?: [object]
-
type: string
PersistentModel
Persistent
Model: Readonly<Record<string, any>>
PersistentModelConstructor
PersistentModelConstructor: object
Type declaration
-
constructor: function
-
copyOf: function
- copyOf(src: T, mutator: function): T
PersistentModelMetaData
PersistentModelMetaData: object
Type declaration
-
Optional identifier?: Identifier<T>
-
Optional readOnlyFields?: string
PickProviderOutput
PickProviderOutput: T extends StorageProvider ? T["getProviderName"] extends "AWSS3" ? DefaultOutput : T extends StorageProviderWithCopy & StorageProviderWithGetProperties ? ReturnType<T[api]> : T extends StorageProviderWithCopy ? ReturnType<T[Exclude<api, "getProperties">]> : T extends StorageProviderWithGetProperties ? ReturnType<T[Exclude<api, "copy">]> : ReturnType<T[Exclude<api, "copy" | "getProperties">]> : T extends object ? T extends object ? DefaultOutput : Promise<any> : DefaultOutput
PlaceGeometry
PlaceGeometry: object
PlatformDetectionEntry
PlatformDetectionEntry: object
Type declaration
-
detectionMethod: function
-
PolygonGeometry
PolygonGeometry: object
PredicateExpression
PredicateExpression: TypeName<FT> extends keyof MapTypeToOperands<FT> ? function : never
PredicateFieldType
Predicate
FieldType: NonNullable<Scalar<T extends Promise<infer InnerPromiseType> ? InnerPromiseType : T extends AsyncCollection<infer InnerCollectionType> ? InnerCollectionType : T>>
PredicateGroups
PredicateGroups: object
Type declaration
-
and: function
-
not: function
-
or: function
PredicateObject
PredicateObject: object
Type declaration
-
field: keyof T
-
operand: any
-
operator: keyof AllOperators
PredicatesGroup
PredicatesGroup: object
Type declaration
-
-
type: keyof PredicateGroups<T>
ProducerModelPredicate
ProducerModelPredicate: function
ProducerPaginationInput
ProducerPaginationInput: object
Type declaration
-
Optional limit?: number
-
Optional page?: number
-
ProducerSortPredicate
ProducerSortPredicate: function
Properties
Properties: object
PropertyNameWithStringValue
PropertyNameWithStringValue: string
PropertyNameWithSubsequentDeserializer
PropertyNameWithSubsequentDeserializer: [string, function]
PubSubContent
Pub
SubContent: Record<string, unknown> | string
PubSubObservable
PubSubObservable: object
Type declaration
-
-
value: string | Record<string, unknown>
PutEventsResponse
PutEventsResponse: object
Type declaration
-
EventsResponse: object
-
Optional Results?: object
-
[endpointId: string]: object
-
Optional EventsItemResponse?: object
-
[eventId: string]: object
-
Optional Message?: string
-
Optional StatusCode?: number
PutObjectCommandInputType
PutObjectInput
Put
ObjectInput: Pick<PutObjectCommandInput, "Bucket" | "Key" | "Body" | "ServerSideEncryption" | "SSECustomerAlgorithm" | "SSECustomerKey" | "SSECustomerKeyMD5" | "SSEKMSKeyId" | "ACL" | "CacheControl" | "ContentDisposition" | "ContentEncoding" | "ContentType" | "ContentMD5" | "Expires" | "Metadata" | "Tagging">
PutResult
PutResult: object
RecursiveModelPredicateAggregateExtender
RecursiveModelPredicateAggregateExtender: function
RecursiveModelPredicateExtender
RecursiveModelPredicateExtender: function
RecursiveModelPredicateNegation
RecursiveModelPredicateNegation: function
RecursiveModelPredicateOperator
RecursiveModelPredicateOperator: function
RelationType
RelationType: object
Type declaration
-
Optional associatedWith?: string | string[]
-
fieldName: string
-
modelName: string
-
relationType: "HAS_ONE" | "HAS_MANY" | "BELONGS_TO"
-
Optional targetName?: string
-
Optional targetNames?: string[]
RelationshipType
RelationshipType: object
Type declaration
-
[modelName: string]: object
ReplicationStatus
ReplicationStatus: object[keyof typeof ReplicationStatus]
RequestCharged
RequestCharged: object[keyof typeof RequestCharged]
RequestPayer
RequestPayer: object[keyof typeof RequestPayer]
ResponseBodyMixin
ResponseBodyMixin: Pick<Body, "blob" | "json" | "text">
ResumableUploadConfig
ResumableUploadConfig: object
Type declaration
-
Optional completeCallback?: function
-
Optional errorCallback?: function
-
Optional progressCallback?: function
-
resumable: true
S3Bucket
S3Bucket: string
S3EndpointResolverOptions
S3ObjectName
S3ObjectName: string
S3ObjectVersion
S3ObjectVersion: string
S3ProviderCopyOutput
S3ProviderCopyOutput: object
S3ProviderGetOuput
S3ProviderGetOuput: T extends object ? GetObjectOutput : string
S3ProviderGetPropertiesConfig
S3ProviderGetPropertiesOutput
S3ProviderGetPropertiesOutput: object
Type declaration
-
contentLength: number
-
contentType: string
-
eTag: string
-
lastModified: Date
-
metadata: Record<string, string>
S3ProviderListOutput
S3ProviderListOutput: object
Type declaration
-
hasNextToken: boolean
-
Optional nextToken?: string
-
S3ProviderPutOutput
S3ProviderPutOutput: T extends object ? UploadTask : Promise<PutResult>
SaveGeofencesResults
SaveGeofencesResults: object
Scalar
Scalar: T extends Array<infer InnerType> ? InnerType : T
SchemaEnum
SchemaEnum: object
Type declaration
-
name: string
-
values: string[]
SchemaModel
SchemaModel: object
Type declaration
-
-
-
-
name: string
-
pluralName: string
-
Optional syncable?: boolean
SchemaNonModel
SchemaNonModel: object
SearchByCoordinatesOptions
SearchByCoordinatesOptions: object
Type declaration
-
Optional maxResults?: number
-
Optional providerName?: string
-
Optional searchIndexName?: string
SearchForSuggestionsResult
SearchForSuggestionsResult: object
Type declaration
-
Optional placeId?: string
-
text: string
SearchForSuggestionsResults
ServerSideEncryption
ServerSideEncryption: object[keyof typeof ServerSideEncryption]
SessionState
SessionState: "started" | "ended"
SessionStateChangeHandler
SessionStateChangeHandler: function
SettableFieldType
SettableFieldType: T extends Promise<infer InnerPromiseType> ? undefined extends InnerPromiseType ? InnerPromiseType | null : InnerPromiseType : T extends AsyncCollection<infer InnerCollectionType> ? InnerCollectionType[] | undefined : undefined extends T ? T | null : T
SettingMetaData
SettingMetaData: object
SortPredicate
SortPredicate: object
SortPredicateExpression
SortPredicateExpression: TypeName<FT> extends keyof MapTypeToOperands<FT> ? function : never
SortPredicateObject
SortPredicateObject: object
Type declaration
-
field: keyof T
-
sortDirection: keyof typeof SortDirection
SourceData
SourceData: string | ArrayBuffer | ArrayBufferView
StartParams
StartParams: object
StorageAccessLevel
StorageAccessLevel: "public" | "protected" | "private"
StorageCopyConfig
StorageCopyConfig: T extends StorageProviderWithCopy ? StorageOperationConfig<T, "copy"> : StorageOperationConfigMap<StorageOperationConfig<AWSS3Provider, "copy">, T>
StorageCopyTarget
StorageCopyTarget: object
Type declaration
-
Optional identityId?: string
-
key: string
-
Optional level?: string
StorageFacade
Storage
Facade: Omit<Adapter, "setUp">
StorageGetConfig
StorageGetConfig: T extends StorageProvider ? StorageOperationConfig<T, "get"> : StorageOperationConfigMap<StorageOperationConfig<AWSS3Provider, "get">, T>
StorageGetPropertiesConfig
StorageGetPropertiesConfig: T extends StorageProviderWithGetProperties ? StorageOperationConfig<T, "getProperties"> : StorageOperationConfigMap<StorageOperationConfig<AWSS3Provider, "getProperties">, T>
StorageGetPropertiesOutput
StorageListConfig
StorageListConfig: T extends StorageProvider ? StorageOperationConfig<T, "list"> : StorageOperationConfigMap<StorageOperationConfig<AWSS3Provider, "list">, T>
StorageOperationConfig
StorageOperationConfig: ReturnType<T["getProviderName"]> extends "AWSS3" ? LastParameter<AWSS3Provider[U]> : T extends StorageProviderWithGetProperties & StorageProviderWithCopy ? LastParameter<T[U]> & object : T extends StorageProviderWithCopy ? LastParameter<T[Exclude<U, "getProperties">]> & object : T extends StorageProviderWithGetProperties ? LastParameter<T[Exclude<U, "copy">]> & object : LastParameter<T[Exclude<U, "copy" | "getProperties">]> & object
StorageOperationConfigMap
StorageOperationConfigMap: T extends object ? T extends object ? Default : T & object : Default
StorageProviderApi
StorageProviderApi: "copy" | "get" | "put" | "remove" | "list" | "getProperties"
StoragePutConfig
StoragePutConfig: T extends StorageProvider ? StorageOperationConfig<T, "put"> : StorageOperationConfigMap<StorageOperationConfig<AWSS3Provider, "put">, T>
StorageRemoveConfig
StorageRemoveConfig: T extends StorageProvider ? StorageOperationConfig<T, "remove"> : StorageOperationConfigMap<StorageOperationConfig<AWSS3Provider, "remove">, T>
StorageSubscriptionMessage