Skip to content

Docs: Verify Astrocyte method signatures in tutorial examples #55

@kluth

Description

@kluth

Problem

Tutorial uses Astrocyte methods that need verification against actual implementation.

Affected Files

Documentation: /home/matthias/projects/synapse/docs/getting-started/first-app.md (lines 254-259)
Source Code: /home/matthias/projects/synapse/src/glial/Astrocyte.ts

Issue Details

Severity: MEDIUM
Impact: Tutorial code may fail at runtime with "method not found" errors

Methods Requiring Verification

public getStats() {
  return {
    totalUsers: this.userStore.getKeysByPattern('user:*').length,     // Verify this method exists
    activeSessions: this.sessionStore.getKeysByPattern('session:*').length,  // Verify this method exists
    userStoreStats: this.userStore.getStatistics(),    // Verify this method exists
    sessionStoreStats: this.sessionStore.getStatistics(),  // Verify this method exists
  };
}

Tasks

  1. Check if Astrocyte.getKeysByPattern() exists in source code
  2. Check if Astrocyte.getStatistics() exists in source code
  3. If methods don't exist, find correct method names
  4. Update tutorial with correct API calls

Priority

MEDIUM - Code verification needed to ensure tutorial accuracy

References

User Story

As a developer following the tutorial, I want method calls to match actual implementation, so that my code runs without method-not-found errors.

Acceptance Criteria

  • Verify getKeysByPattern() method exists or find alternative
  • Verify getStatistics() method exists or find alternative
  • Update tutorial code with correct method names
  • Test that updated code executes successfully

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationmediumMedium priority - fix next sprint

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions