@foxpage/foxpage-node-sdk/lib/common/env.d.ts

foxpage node sdk

import { Context } from '@foxpage/foxpage-types';
/**
 * check is preview mode
 */
export declare const isPreview: (ctx: Context) => boolean;
/**
 * check is module view
 */
export declare const isModuleView: (ctx: Context) => boolean;
/**
 * check is debug mode
 */
export declare const isDebug: (ctx: Context) => boolean;
/**
 * check is debug mode
 */
export declare const isMock: (ctx: Context) => boolean;
/**
 * check is canary mode
 */
export declare const isCanary: (ctx: Context) => boolean;
export declare const isTest: (ctx: Context) => boolean;
/**
 * init canary
 * @param ctx
 * @returns
 */
export declare const initCanary: (ctx: Context) => boolean;
/**
 * init mode
 * @param ctx context
 */
export declare const initEnv: (ctx: Context) => void;
/**
 * is prod
 * @param ctx
 * @returns
 */
export declare const isProd: (ctx: Context) => boolean;
/**
 * get foxpage preview time
 * @param ctx context
 * @returns preview time
 */
export declare function getFoxpagePreviewTime(ctx: Context): string | undefined;
/**
 * get foxpage access control ticket
 * @param ctx context
 * @returns ticket
 */
export declare function getTicket(ctx: Context): string | undefined;
/**
 * get pageId
 * @param ctx
 * @returns
 */
export declare function getPageId(ctx: Context): string | undefined;
/**
 * get preview locale
 * @param ctx context
 * @returns preview locale
 */
export declare function getPreviewLocale(ctx: Context): string | undefined;
/**
 * get preview version
 * @param ctx context
 * @returns preview version
 */
export declare function getPreviewVersion(ctx: Context): number | undefined;
/**
 * get mock condition
 * @param ctx context
 * @returns mock conditions
 */
export declare function getMockConditions(ctx: Context): string[] | undefined;