Skip to content

Docs: 'Using TA Cache for Performance' example does not match run() signature #174

@cybito

Description

@cybito

Hi, I found a documentation inconsistency.

In docs/initialization-and-usage.md, Example 6 (Using TA Cache for Performance) shows:

await pineTS.run(fn, undefined, true)

and describes the third argument as enabling cache.

However, in the current source, run() is defined as:

  • run(pineTSCode, periods?)
  • run(pineTSCode, periods, pageSize)

So the third argument is pageSize: number, not a boolean cache flag.

Relevant locations:

  • Docs: docs/initialization-and-usage.md Example 6
  • Source: src/PineTS.class.ts

It looks like the example is outdated or the docs need clarification about the current API.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions