aws-amplify
Version:
AWS Amplify is a JavaScript library for Frontend and mobile developers building cloud-enabled applications.
29 lines (28 loc) • 1.57 kB
TypeScript
import { AmplifyServer } from '@aws-amplify/core/internals/adapter-core';
/**
* The low level function that supports framework specific helpers.
* It creates an Amplify server context based on the input and runs the
* operation with injecting the context, and finally returns the result of the
* operation.
*
* @deprecated This registry-backed API is retained solely so OLD published
* `@aws-amplify/adapter-nextjs` versions (≤ 1.7.3, peer
* `aws-amplify: ^6.16.4`) — which call it at runtime with cookie-backed
* token/credentials providers in `libraryOptions` — keep working against this
* version of `aws-amplify`. It will be removed in the next major version.
*
* The created context spec is a REAL branded `AmplifyContext` (structurally
* compatible with the legacy `ContextSpec` shape), so operations may pass it
* both to new context-first server APIs (e.g. `fetchAuthSession(contextSpec)`)
* and to the deprecated `getAmplifyServerContext(contextSpec).amplify` lookup.
* New code should build a context explicitly with `createAmplifyContext()`
* (or use `@aws-amplify/adapter-nextjs`'s `createRunWithAmplifyServerContext`
* for per-request isolation) instead.
*
* @param amplifyConfig The Amplify resource config.
* @param libraryOptions The Amplify library options.
* @param operation The operation to run with the server context created from
* `amplifyConfig` and `libraryOptions`.
* @returns The result returned by the `operation`.
*/
export declare const runWithAmplifyServerContext: AmplifyServer.RunOperationWithContext;