modules.md

cf-migrations API

Table of contents

Type aliases

• ContentfulPartialOptions
• DeployOptions
• MigrationOptions
• ReleaseOptions

Functions

• createReleaseEnvironment
• deployMigrations
• initEnvironment

Type aliases

ContentfulPartialOptions

Ƭ ContentfulPartialOptions: object

Type declaration:

Name	Type
accessToken	string
environmentId	string
locale?	string
spaceId	string

Defined in: types.ts:1

---

DeployOptions

Ƭ DeployOptions: object

Type declaration:

Name	Type
deployedMigrations?	string[]
migrationNames?	string[]
options	MigrationOptions

Defined in: deploy.ts:15

---

MigrationOptions

Ƭ MigrationOptions: ContentfulPartialOptions & { migrationsDirectory: string ; yes?: boolean }

Defined in: types.ts:8

---

ReleaseOptions

Ƭ ReleaseOptions: object

Type declaration:

Name	Type
availableEnvironments	number
ignoreMigrationCheck?	boolean
options	MigrationOptions
releasePrefix	string

Defined in: createReleaseEnvironment.ts:16

Functions

createReleaseEnvironment

▸ createReleaseEnvironment(__namedParameters: ReleaseOptions): Promise<undefined | string>

Parameters:

Name	Type
__namedParameters	ReleaseOptions

Returns: Promise<undefined | string>

Defined in: createReleaseEnvironment.ts:23

---

deployMigrations

▸ deployMigrations(__namedParameters: DeployOptions): Promise<PendingMigration[]>

Parameters:

Name	Type
__namedParameters	DeployOptions

Returns: Promise<PendingMigration[]>

Defined in: deploy.ts:21

---

initEnvironment

▸ initEnvironment(options: ContentfulPartialOptions): Promise<void>

Parameters:

Name	Type
options	ContentfulPartialOptions

Returns: Promise<void>

Defined in: initEnvironment.ts:7