feat: rename getOrderedNarratives to getNarratives

BREAKING CHANGE: Replace 'getOrderedNarratives' method with 'getNarratives' This method retrieves an ordered array of narratives from the nodes property.
tabkram · Dec 15, 2023 · ec8aea9 · ec8aea9
1 parent c38efe9
commit ec8aea9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/src/trace/traceableExecution.spec.ts b/src/trace/traceableExecution.spec.ts
@@ -298,7 +298,7 @@ describe('TraceableExecution', () => {
  ]);
 
  // Get the ordered narratives and verify their content
- const orderedNarratives = traceableExecution.getOrderedNarratives();
+ const orderedNarratives = traceableExecution.getNarratives();
  expect(orderedNarratives).toEqual([
  'Narrative 0',
  'Narrative 0 with Result: InputParam',

diff --git a/src/trace/traceableExecution.ts b/src/trace/traceableExecution.ts
@@ -309,10 +309,11 @@ export class TraceableExecution {
  }
 
  /**
- * Gets an ordered array of narratives.
- * @returns An array containing ordered narratives.
+ * Retrieves an ordered array of narratives.
+ *
+ * @returns {Array<string>} An array that contains the ordered narratives. If no narratives are found, an empty array is returned.
  */
- getOrderedNarratives(): Array<string> {
+ getNarratives(): Array<string> {
  return this.nodes?.flatMap?.((n) => n.data?.narratives)?.filter((n) => !!n);
  }