convex
Version:
Client for the Convex Cloud
31 lines • 1.31 kB
TypeScript
import { Context } from "../../../bundler/context.js";
export declare const LEGACY_LOCAL_BACKEND_INSTANCE_SECRET = "4361726e697461732c206c69746572616c6c79206d65616e696e6720226c6974";
/**
* Generates an instance secret and an admin key for a new (or just upgraded) local deployment.
*/
export declare function generateLocalDevSecrets(ctx: Context, { deploymentName, latestBinaryPath, }: {
deploymentName: string;
/**
* A path to the local backend binary.
*
* This must always be the latest version of the local binary that has been published,
* in order to make sure the `keygen admin-key` command is available. If you need to call
* this without having access to the latest binary, use `generateLocalDevSecretsWithLatestBinary`
* which will download the latest version when necessary.
*/
latestBinaryPath: string;
}): Promise<{
instanceSecret: string;
adminKey: string;
}>;
/**
* Similar to generateLocalDevSecrets, but can be called when we’re not confident
* we have a binary that supports `keygen admin-key`
*/
export declare function generateLocalDevSecretsWithLatestBinary(ctx: Context, { deploymentName, }: {
deploymentName: string;
}): Promise<{
instanceSecret: string;
adminKey: string;
}>;
//# sourceMappingURL=secrets.d.ts.map