@salesforce/b2c-tooling-sdk / operations/mrt / PushOptions
Interface: PushOptions
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:23
Options for pushing a bundle to MRT.
Extends
Properties
buildDirectory?
optionalbuildDirectory:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:85
Path to the build directory containing the application build output.
Default
'build'Inherited from
CreateBundleOptions.buildDirectory
message?
optionalmessage:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:57
Optional message describing the bundle. Defaults to a git-based message or a timestamp.
Inherited from
origin?
optionalorigin:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:34
MRT API origin URL.
Default
"https://cloud.mobify.com"projectDirectory?
optionalprojectDirectory:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:94
Directory to read config.server.{ts,js} from when ssrOnly/ssrShared are not provided explicitly. The config is read straight from source at bundle time (no build step), so config.server.js need not be emitted into the build output.
Default
process.cwd()Inherited from
CreateBundleOptions.projectDirectory
projectSlug
projectSlug:
string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:100
Project slug for the MRT project. Used to prefix files in the archive.
Inherited from
CreateBundleOptions.projectSlug
ssrOnly?
optionalssrOnly:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:71
Glob patterns for files that should only run on the server. If omitted, loaded from config.server.{ts,js} in the project directory (or the legacy build/config.server.js) if present.
Example
['ssr.js', 'ssr/*.js']Inherited from
ssrParameters?
optionalssrParameters:Record<string,unknown>
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:63
SSR parameters to include in the bundle. These are configuration values for the SSR runtime.
Inherited from
CreateBundleOptions.ssrParameters
ssrShared?
optionalssrShared:string[]
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/bundle.ts:79
Glob patterns for files shared between client and server. If omitted, loaded from config.server.{ts,js} in the project directory (or the legacy build/config.server.js) if present.
Example
['static/**/*', '**/*.js']Inherited from
target?
optionaltarget:string
Defined in: packages/b2c-tooling-sdk/src/operations/mrt/push.ts:28
Target environment to deploy to after push. If not provided, bundle is uploaded but not deployed.