Skip to content

Commit

Permalink
Revert usage of $ in scripts, change docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ralphhanna committed Jan 23, 2024
1 parent d8a5b7d commit b358553
Show file tree
Hide file tree
Showing 122 changed files with 2,945 additions and 2,361 deletions.
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# bpmn-server Overview
# Overview Home

`bpmn-server` provides a Workflow component based on **Business Process Model and Notation** that can be easily integrated into your application.

Expand Down Expand Up @@ -191,10 +191,10 @@ Enter Command, q to quit, or ? to list commands
- [Security](security.md)
- [Data](data.md)
- [Input/Output](data#input-output-data.md)
- [Data Query](data#data-query.md)
- [Data Query](data#dataQuery.md)
- [Examples](examples.md)
- [API Summary](api-summary.md)
- [API](./api/readme.md)
- [API](api)
- [Setup](setup.md)
- [Application Integration](customization.md)

Expand Down
16 changes: 8 additions & 8 deletions docs/api/classes/APIData.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ APIComponent.constructor

#### Defined in

[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L24)
[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L24)

## Properties

Expand All @@ -66,7 +66,7 @@ APIComponent.api

#### Defined in

[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L22)
[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L22)

## Accessors

Expand All @@ -84,7 +84,7 @@ APIComponent.server

#### Defined in

[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L27)
[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L27)

## Methods

Expand All @@ -105,7 +105,7 @@ APIComponent.server

#### Defined in

[API/API.ts:179](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L179)
[API/API.ts:179](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L179)

___

Expand All @@ -126,7 +126,7 @@ ___

#### Defined in

[API/API.ts:187](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L187)
[API/API.ts:187](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L187)

___

Expand All @@ -147,7 +147,7 @@ ___

#### Defined in

[API/API.ts:191](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L191)
[API/API.ts:191](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L191)

___

Expand All @@ -169,7 +169,7 @@ ___

#### Defined in

[API/API.ts:196](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L196)
[API/API.ts:196](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L196)

___

Expand All @@ -190,4 +190,4 @@ ___

#### Defined in

[API/API.ts:200](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L200)
[API/API.ts:200](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L200)
18 changes: 9 additions & 9 deletions docs/api/classes/APIEngine.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ APIComponent.constructor

#### Defined in

[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L24)
[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L24)

## Properties

Expand All @@ -84,7 +84,7 @@ APIComponent.api

#### Defined in

[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L22)
[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L22)

## Accessors

Expand All @@ -102,7 +102,7 @@ APIComponent.server

#### Defined in

[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L27)
[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L27)

## Methods

Expand Down Expand Up @@ -131,7 +131,7 @@ start a new Instance of specified model

#### Defined in

[API/API.ts:155](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L155)
[API/API.ts:155](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L155)

___

Expand Down Expand Up @@ -160,7 +160,7 @@ continue with the execution of a particular item that is in a wait state, typica

#### Defined in

[API/API.ts:159](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L159)
[API/API.ts:159](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L159)

___

Expand Down Expand Up @@ -190,7 +190,7 @@ provide assignment data to a user task

#### Defined in

[API/API.ts:164](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L164)
[API/API.ts:164](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L164)

___

Expand Down Expand Up @@ -220,7 +220,7 @@ throw a message with an id, system will identify receiving item

#### Defined in

[API/API.ts:168](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L168)
[API/API.ts:168](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L168)

___

Expand Down Expand Up @@ -250,7 +250,7 @@ throw a signal with an id, system will identify receiving item(s)

#### Defined in

[API/API.ts:171](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L171)
[API/API.ts:171](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L171)

___

Expand Down Expand Up @@ -280,4 +280,4 @@ start a second event node (in a subprocess) for a running instance

#### Defined in

[API/API.ts:174](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L174)
[API/API.ts:174](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L174)
24 changes: 12 additions & 12 deletions docs/api/classes/APIModel.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ APIComponent.constructor

#### Defined in

[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L24)
[API/API.ts:24](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L24)

## Properties

Expand All @@ -70,7 +70,7 @@ APIComponent.api

#### Defined in

[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L22)
[API/API.ts:22](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L22)

## Accessors

Expand All @@ -88,7 +88,7 @@ APIComponent.server

#### Defined in

[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L27)
[API/API.ts:27](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L27)

## Methods

Expand All @@ -111,7 +111,7 @@ APIComponent.server

#### Defined in

[API/API.ts:207](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L207)
[API/API.ts:207](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L207)

___

Expand All @@ -132,7 +132,7 @@ ___

#### Defined in

[API/API.ts:214](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L214)
[API/API.ts:214](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L214)

___

Expand All @@ -153,7 +153,7 @@ ___

#### Defined in

[API/API.ts:220](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L220)
[API/API.ts:220](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L220)

___

Expand All @@ -174,7 +174,7 @@ ___

#### Defined in

[API/API.ts:224](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L224)
[API/API.ts:224](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L224)

___

Expand All @@ -195,7 +195,7 @@ ___

#### Defined in

[API/API.ts:229](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L229)
[API/API.ts:229](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L229)

___

Expand All @@ -217,7 +217,7 @@ ___

#### Defined in

[API/API.ts:234](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L234)
[API/API.ts:234](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L234)

___

Expand All @@ -238,7 +238,7 @@ ___

#### Defined in

[API/API.ts:239](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L239)
[API/API.ts:239](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L239)

___

Expand All @@ -259,7 +259,7 @@ ___

#### Defined in

[API/API.ts:242](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L242)
[API/API.ts:242](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L242)

___

Expand All @@ -281,4 +281,4 @@ ___

#### Defined in

[API/API.ts:245](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L245)
[API/API.ts:245](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L245)
10 changes: 5 additions & 5 deletions docs/api/classes/BPMNAPI.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@

#### Defined in

[API/API.ts:14](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L14)
[API/API.ts:14](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L14)

## Properties

Expand All @@ -43,7 +43,7 @@

#### Defined in

[API/API.ts:9](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L9)
[API/API.ts:9](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L9)

___

Expand All @@ -53,7 +53,7 @@ ___

#### Defined in

[API/API.ts:10](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L10)
[API/API.ts:10](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L10)

___

Expand All @@ -63,7 +63,7 @@ ___

#### Defined in

[API/API.ts:11](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L11)
[API/API.ts:11](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L11)

___

Expand All @@ -73,4 +73,4 @@ ___

#### Defined in

[API/API.ts:12](https://github.com/bpmnServer/bpmn-server/blob/6f144fc/src/API/API.ts#L12)
[API/API.ts:12](https://github.com/bpmnServer/bpmn-server/blob/d8a5b7d/src/API/API.ts#L12)
Loading

0 comments on commit b358553

Please sign in to comment.