Skip to content

Commit 6de5a0c

Browse files
committed
FIx typo
1 parent 26b2f11 commit 6de5a0c

File tree

75 files changed

+506
-520
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+506
-520
lines changed

docs/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
[@melonade/melonade-declaration - v0.7.7](README.md)[Globals](globals.md)
1+
[@melonade/melonade-declaration - v0.8.0](README.md)[Globals](globals.md)
22

3-
# @melonade/melonade-declaration - v0.7.7
3+
# @melonade/melonade-declaration - v0.8.0
44

55
# melonade-declaration
66

@@ -14,6 +14,10 @@ Type declaration of melonade
1414

1515
npm install
1616
npm run json-schema
17+
npm run build:docs
18+
19+
npm run test
20+
# npm publish
1721
```
1822

1923
## Tasks

docs/classes/_taskdefinition_.taskdefinition.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@melonade/melonade-declaration - v0.7.7](../README.md)[Globals](../globals.md)["taskDefinition"](../modules/_taskdefinition_.md)[TaskDefinition](_taskdefinition_.taskdefinition.md)
1+
[@melonade/melonade-declaration - v0.8.0](../README.md)[Globals](../globals.md)["taskDefinition"](../modules/_taskdefinition_.md)[TaskDefinition](_taskdefinition_.taskdefinition.md)
22

33
# Class: TaskDefinition
44

@@ -31,7 +31,7 @@
3131

3232
\+ **new TaskDefinition**(`taskDefinition`: [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md)): *[TaskDefinition](_taskdefinition_.taskdefinition.md)*
3333

34-
*Defined in [src/taskDefinition.ts:81](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L81)*
34+
*Defined in [src/taskDefinition.ts:81](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L81)*
3535

3636
**Parameters:**
3737

@@ -49,7 +49,7 @@ Name | Type |
4949

5050
*Implementation of [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md).[ackTimeout](../interfaces/_taskdefinition_.itaskdefinition.md#optional-acktimeout)*
5151

52-
*Defined in [src/taskDefinition.ts:78](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L78)*
52+
*Defined in [src/taskDefinition.ts:78](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L78)*
5353

5454
___
5555

@@ -59,7 +59,7 @@ ___
5959

6060
*Implementation of [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md).[description](../interfaces/_taskdefinition_.itaskdefinition.md#optional-description)*
6161

62-
*Defined in [src/taskDefinition.ts:77](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L77)*
62+
*Defined in [src/taskDefinition.ts:77](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L77)*
6363

6464
___
6565

@@ -69,7 +69,7 @@ ___
6969

7070
*Implementation of [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md).[document](../interfaces/_taskdefinition_.itaskdefinition.md#optional-document)*
7171

72-
*Defined in [src/taskDefinition.ts:81](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L81)*
72+
*Defined in [src/taskDefinition.ts:81](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L81)*
7373

7474
___
7575

@@ -79,7 +79,7 @@ ___
7979

8080
*Implementation of [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md).[name](../interfaces/_taskdefinition_.itaskdefinition.md#name)*
8181

82-
*Defined in [src/taskDefinition.ts:76](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L76)*
82+
*Defined in [src/taskDefinition.ts:76](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L76)*
8383

8484
___
8585

@@ -89,7 +89,7 @@ ___
8989

9090
*Implementation of [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md).[retry](../interfaces/_taskdefinition_.itaskdefinition.md#optional-retry)*
9191

92-
*Defined in [src/taskDefinition.ts:80](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L80)*
92+
*Defined in [src/taskDefinition.ts:80](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L80)*
9393

9494
___
9595

@@ -99,4 +99,4 @@ ___
9999

100100
*Implementation of [ITaskDefinition](../interfaces/_taskdefinition_.itaskdefinition.md).[timeout](../interfaces/_taskdefinition_.itaskdefinition.md#optional-timeout)*
101101

102-
*Defined in [src/taskDefinition.ts:79](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/taskDefinition.ts#L79)*
102+
*Defined in [src/taskDefinition.ts:79](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/taskDefinition.ts#L79)*

docs/classes/_workflowdefinition_.workflowdefinition.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@melonade/melonade-declaration - v0.7.7](../README.md)[Globals](../globals.md)["workflowDefinition"](../modules/_workflowdefinition_.md)[WorkflowDefinition](_workflowdefinition_.workflowdefinition.md)
1+
[@melonade/melonade-declaration - v0.8.0](../README.md)[Globals](../globals.md)["workflowDefinition"](../modules/_workflowdefinition_.md)[WorkflowDefinition](_workflowdefinition_.workflowdefinition.md)
22

33
# Class: WorkflowDefinition
44

@@ -33,7 +33,7 @@
3333

3434
\+ **new WorkflowDefinition**(`workflowDefinition`: [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md)): *[WorkflowDefinition](_workflowdefinition_.workflowdefinition.md)*
3535

36-
*Defined in [src/workflowDefinition.ts:355](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L355)*
36+
*Defined in [src/workflowDefinition.ts:342](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L342)*
3737

3838
**Parameters:**
3939

@@ -51,7 +51,7 @@ Name | Type |
5151

5252
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[description](../interfaces/_workflowdefinition_.iworkflowdefinition.md#optional-description)*
5353

54-
*Defined in [src/workflowDefinition.ts:350](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L350)*
54+
*Defined in [src/workflowDefinition.ts:337](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L337)*
5555

5656
___
5757

@@ -61,7 +61,7 @@ ___
6161

6262
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[failureStrategy](../interfaces/_workflowdefinition_.iworkflowdefinition.md#optional-failurestrategy)*
6363

64-
*Defined in [src/workflowDefinition.ts:352](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L352)*
64+
*Defined in [src/workflowDefinition.ts:339](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L339)*
6565

6666
___
6767

@@ -71,7 +71,7 @@ ___
7171

7272
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[name](../interfaces/_workflowdefinition_.iworkflowdefinition.md#name)*
7373

74-
*Defined in [src/workflowDefinition.ts:348](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L348)*
74+
*Defined in [src/workflowDefinition.ts:335](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L335)*
7575

7676
___
7777

@@ -81,7 +81,7 @@ ___
8181

8282
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[outputParameters](../interfaces/_workflowdefinition_.iworkflowdefinition.md#optional-outputparameters)*
8383

84-
*Defined in [src/workflowDefinition.ts:355](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L355)*
84+
*Defined in [src/workflowDefinition.ts:342](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L342)*
8585

8686
___
8787

@@ -91,7 +91,7 @@ ___
9191

9292
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[recoveryWorkflow](../interfaces/_workflowdefinition_.iworkflowdefinition.md#optional-recoveryworkflow)*
9393

94-
*Defined in [src/workflowDefinition.ts:354](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L354)*
94+
*Defined in [src/workflowDefinition.ts:341](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L341)*
9595

9696
___
9797

@@ -101,7 +101,7 @@ ___
101101

102102
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[retry](../interfaces/_workflowdefinition_.iworkflowdefinition.md#optional-retry)*
103103

104-
*Defined in [src/workflowDefinition.ts:353](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L353)*
104+
*Defined in [src/workflowDefinition.ts:340](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L340)*
105105

106106
___
107107

@@ -111,7 +111,7 @@ ___
111111

112112
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[rev](../interfaces/_workflowdefinition_.iworkflowdefinition.md#rev)*
113113

114-
*Defined in [src/workflowDefinition.ts:349](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L349)*
114+
*Defined in [src/workflowDefinition.ts:336](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L336)*
115115

116116
___
117117

@@ -121,4 +121,4 @@ ___
121121

122122
*Implementation of [IWorkflowDefinition](../interfaces/_workflowdefinition_.iworkflowdefinition.md).[tasks](../interfaces/_workflowdefinition_.iworkflowdefinition.md#tasks)*
123123

124-
*Defined in [src/workflowDefinition.ts:351](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/workflowDefinition.ts#L351)*
124+
*Defined in [src/workflowDefinition.ts:338](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/workflowDefinition.ts#L338)*

docs/enums/_command_.commandtypes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@melonade/melonade-declaration - v0.7.7](../README.md)[Globals](../globals.md)["command"](../modules/_command_.md)[CommandTypes](_command_.commandtypes.md)
1+
[@melonade/melonade-declaration - v0.8.0](../README.md)[Globals](../globals.md)["command"](../modules/_command_.md)[CommandTypes](_command_.commandtypes.md)
22

33
# Enumeration: CommandTypes
44

@@ -18,36 +18,36 @@
1818

1919
**CancelTransaction**: = "CANCEL_TRANSACTION"
2020

21-
*Defined in [src/command.ts:6](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/command.ts#L6)*
21+
*Defined in [src/command.ts:6](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/command.ts#L6)*
2222

2323
___
2424

2525
### PauseTransaction
2626

2727
**PauseTransaction**: = "PAUSE_TRANSACTION"
2828

29-
*Defined in [src/command.ts:7](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/command.ts#L7)*
29+
*Defined in [src/command.ts:7](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/command.ts#L7)*
3030

3131
___
3232

3333
### ReloadTask
3434

3535
**ReloadTask**: = "RELOAD_TASK"
3636

37-
*Defined in [src/command.ts:9](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/command.ts#L9)*
37+
*Defined in [src/command.ts:9](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/command.ts#L9)*
3838

3939
___
4040

4141
### ResumeTransaction
4242

4343
**ResumeTransaction**: = "RESUME_TRANSACTION"
4444

45-
*Defined in [src/command.ts:8](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/command.ts#L8)*
45+
*Defined in [src/command.ts:8](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/command.ts#L8)*
4646

4747
___
4848

4949
### StartTransaction
5050

5151
**StartTransaction**: = "START_TRANSACTION"
5252

53-
*Defined in [src/command.ts:5](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/command.ts#L5)*
53+
*Defined in [src/command.ts:5](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/command.ts#L5)*

docs/enums/_kafka_.topicsuffix.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@melonade/melonade-declaration - v0.7.7](../README.md)[Globals](../globals.md)["kafka"](../modules/_kafka_.md)[topicSuffix](_kafka_.topicsuffix.md)
1+
[@melonade/melonade-declaration - v0.8.0](../README.md)[Globals](../globals.md)["kafka"](../modules/_kafka_.md)[topicSuffix](_kafka_.topicsuffix.md)
22

33
# Enumeration: topicSuffix
44

@@ -18,36 +18,36 @@
1818

1919
**command**: = "command"
2020

21-
*Defined in [src/kafka.ts:7](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/kafka.ts#L7)*
21+
*Defined in [src/kafka.ts:7](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/kafka.ts#L7)*
2222

2323
___
2424

2525
### event
2626

2727
**event**: = "event"
2828

29-
*Defined in [src/kafka.ts:4](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/kafka.ts#L4)*
29+
*Defined in [src/kafka.ts:4](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/kafka.ts#L4)*
3030

3131
___
3232

3333
### store
3434

3535
**store**: = "store"
3636

37-
*Defined in [src/kafka.ts:5](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/kafka.ts#L5)*
37+
*Defined in [src/kafka.ts:5](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/kafka.ts#L5)*
3838

3939
___
4040

4141
### task
4242

4343
**task**: = "task"
4444

45-
*Defined in [src/kafka.ts:6](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/kafka.ts#L6)*
45+
*Defined in [src/kafka.ts:6](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/kafka.ts#L6)*
4646

4747
___
4848

4949
### timer
5050

5151
**timer**: = "timer"
5252

53-
*Defined in [src/kafka.ts:8](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/kafka.ts#L8)*
53+
*Defined in [src/kafka.ts:8](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/kafka.ts#L8)*

docs/enums/_state_.taskstates.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@melonade/melonade-declaration - v0.7.7](../README.md)[Globals](../globals.md)["state"](../modules/_state_.md)[TaskStates](_state_.taskstates.md)
1+
[@melonade/melonade-declaration - v0.8.0](../README.md)[Globals](../globals.md)["state"](../modules/_state_.md)[TaskStates](_state_.taskstates.md)
22

33
# Enumeration: TaskStates
44

@@ -19,44 +19,44 @@
1919

2020
**AckTimeOut**: = "ACK_TIMEOUT"
2121

22-
*Defined in [src/state.ts:163](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L163)*
22+
*Defined in [src/state.ts:163](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L163)*
2323

2424
___
2525

2626
### Completed
2727

2828
**Completed**: = "COMPLETED"
2929

30-
*Defined in [src/state.ts:160](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L160)*
30+
*Defined in [src/state.ts:160](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L160)*
3131

3232
___
3333

3434
### Failed
3535

3636
**Failed**: = "FAILED"
3737

38-
*Defined in [src/state.ts:161](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L161)*
38+
*Defined in [src/state.ts:161](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L161)*
3939

4040
___
4141

4242
### Inprogress
4343

4444
**Inprogress**: = "INPROGRESS"
4545

46-
*Defined in [src/state.ts:159](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L159)*
46+
*Defined in [src/state.ts:159](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L159)*
4747

4848
___
4949

5050
### Scheduled
5151

5252
**Scheduled**: = "SCHEDULED"
5353

54-
*Defined in [src/state.ts:158](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L158)*
54+
*Defined in [src/state.ts:158](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L158)*
5555

5656
___
5757

5858
### Timeout
5959

6060
**Timeout**: = "TIMEOUT"
6161

62-
*Defined in [src/state.ts:162](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L162)*
62+
*Defined in [src/state.ts:162](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L162)*

docs/enums/_state_.transactionstates.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[@melonade/melonade-declaration - v0.7.7](../README.md)[Globals](../globals.md)["state"](../modules/_state_.md)[TransactionStates](_state_.transactionstates.md)
1+
[@melonade/melonade-declaration - v0.8.0](../README.md)[Globals](../globals.md)["state"](../modules/_state_.md)[TransactionStates](_state_.transactionstates.md)
22

33
# Enumeration: TransactionStates
44

@@ -19,44 +19,44 @@
1919

2020
**Cancelled**: = "CANCELLED"
2121

22-
*Defined in [src/state.ts:10](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L10)*
22+
*Defined in [src/state.ts:10](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L10)*
2323

2424
___
2525

2626
### Compensated
2727

2828
**Compensated**: = "COMPENSATED"
2929

30-
*Defined in [src/state.ts:11](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L11)*
30+
*Defined in [src/state.ts:11](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L11)*
3131

3232
___
3333

3434
### Completed
3535

3636
**Completed**: = "COMPLETED"
3737

38-
*Defined in [src/state.ts:6](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L6)*
38+
*Defined in [src/state.ts:6](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L6)*
3939

4040
___
4141

4242
### Failed
4343

4444
**Failed**: = "FAILED"
4545

46-
*Defined in [src/state.ts:7](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L7)*
46+
*Defined in [src/state.ts:7](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L7)*
4747

4848
___
4949

5050
### Paused
5151

5252
**Paused**: = "PAUSED"
5353

54-
*Defined in [src/state.ts:9](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L9)*
54+
*Defined in [src/state.ts:9](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L9)*
5555

5656
___
5757

5858
### Running
5959

6060
**Running**: = "RUNNING"
6161

62-
*Defined in [src/state.ts:8](https://github.com/devit-tel/melonade-declaration/blob/43597e6/src/state.ts#L8)*
62+
*Defined in [src/state.ts:8](https://github.com/devit-tel/melonade-declaration/blob/26b2f11/src/state.ts#L8)*

0 commit comments

Comments
 (0)