Skip to content

Commit 420306f

Browse files
committed
Docs: Verify MuscleGroup execution examples (#57)
1 parent e678341 commit 420306f

1 file changed

Lines changed: 4 additions & 15 deletions

File tree

docs/api/API_REFERENCE.md

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -725,26 +725,15 @@ console.log(result); // 'HELLO'
725725

726726
### MuscleGroup
727727

728-
Function pipeline.
728+
A `MuscleGroup` orchestrates a series of `Muscle` instances into a data processing pipeline. The output of one `Muscle` becomes the input for the next, allowing for complex transformations to be built from simple, reusable functions.
729729

730-
```typescript
731-
class MuscleGroup<TInput, TOutput> {
732-
constructor(name: string, muscles: Muscle[])
733-
734-
// Execution
735-
execute(input: TInput): Promise<TOutput>
736-
737-
// Properties
738-
readonly name: string
739-
readonly muscles: Muscle[]
740-
}
741-
```
742-
743-
**Example**:
744730
```typescript
745731
const pipeline = new MuscleGroup('data-pipeline', [
732+
// 1. Parse the CSV string into an array of lines
746733
new Muscle('parse', (csv) => csv.split('\n')),
734+
// 2. Filter out any empty lines
747735
new Muscle('filter', (lines) => lines.filter(line => line.length > 0)),
736+
// 3. Convert each line to uppercase
748737
new Muscle('map', (lines) => lines.map(line => line.toUpperCase())),
749738
]);
750739

0 commit comments

Comments
 (0)