Skip to main content

templates/workflows/shared/managed-workflow

Interfaces​

ManagedWorkflowContext​

Defined in: templates/workflows/shared/managed-workflow.ts:22

Extends​

  • Omit<PinionContext, "pinion">

Properties​

pinion?​
optional pinion: Configuration & object;

Defined in: templates/workflows/shared/managed-workflow.ts:23

Type Declaration​
force?​
optional force: boolean;

Variables​

MANAGED_WORKFLOW_STRINGIFY_OPTIONS​

const MANAGED_WORKFLOW_STRINGIFY_OPTIONS: object;

Defined in: templates/workflows/shared/managed-workflow.ts:28

Type Declaration​

defaultKeyType​
defaultKeyType: "PLAIN";
defaultStringType​
defaultStringType: "PLAIN";
indent​
indent: number = 2;
lineWidth​
lineWidth: number = 0;
minContentWidth​
minContentWidth: number = 0;

Functions​

applyManagedWorkflowOperations()​

function applyManagedWorkflowOperations(
   doc, 
   operations, 
   _ctx): void;

Defined in: templates/workflows/shared/managed-workflow.ts:71

Parameters​

doc​

Parsed

operations​

PathOperationConfig[]

_ctx​

ManagedWorkflowContext

Returns​

void

createManagedWorkflowDocument()​

function createManagedWorkflowDocument(
   headerComment, 
   operations, 
   _ctx): Parsed;

Defined in: templates/workflows/shared/managed-workflow.ts:50

Parameters​

headerComment​

string

operations​

PathOperationConfig[]

_ctx​

ManagedWorkflowContext

Returns​

Parsed

stringifyManagedWorkflow()​

function stringifyManagedWorkflow(doc, options): string;

Defined in: templates/workflows/shared/managed-workflow.ts:79

Parameters​

doc​

Parsed

options​
defaultKeyType​

"PLAIN" = ...

defaultStringType​

"PLAIN" = ...

indent​

number = 2

lineWidth​

number = 0

minContentWidth​

number = 0

Returns​

string

updateManagedWorkflowDocument()​

function updateManagedWorkflowDocument(
   existingContent, 
   operations, 
   _ctx): Parsed;

Defined in: templates/workflows/shared/managed-workflow.ts:61

Parameters​

existingContent​

string

operations​

PathOperationConfig[]

_ctx​

ManagedWorkflowContext

Returns​

Parsed