Skip to content

[Cross-cutting] Create examples demonstrating real-world use cases #22

@konard

Description

@konard

Summary

Create comprehensive examples demonstrating real-world use cases of Links Queue for both JavaScript and Rust.

Background

Examples help users understand how to use Links Queue effectively. They should showcase the unique link-based data model and various operating modes.

Requirements

Basic Examples (can be done early, after Phase 1-2)

  1. Hello World - Simple enqueue/dequeue
  2. Link Relationships - Demonstrating nested links and graph structures
  3. Producer-Consumer - Basic work queue pattern
  4. Deduplication - Showing automatic link deduplication

Intermediate Examples (after Phase 3)

  1. Persistent Queue - Using link-cli backend for durability
  2. Dead Letter Queue - Handling failed messages
  3. Retry with Backoff - Implementing retry logic
  4. Priority Queue - Processing by priority

Advanced Examples (after Phase 5-6)

  1. Client-Server - Connecting to Links Queue server
  2. Multi-Node - Distributed queue across nodes
  3. Fan-out Pattern - Publishing to multiple consumers
  4. Workflow - Chaining queue operations

Example Structure

examples/
├── js/
│   ├── 01-hello-world/
│   │   ├── README.md
│   │   └── index.ts
│   ├── 02-link-relationships/
│   ├── 03-producer-consumer/
│   └── ...
└── rust/
    ├── 01-hello-world/
    │   ├── README.md
    │   └── main.rs
    ├── 02-link-relationships/
    └── ...

Each Example Should Include

  • README.md with explanation
  • Runnable code
  • Expected output
  • Key concepts highlighted

Deliverables

  1. Basic examples (1-4) for JavaScript
  2. Basic examples (1-4) for Rust
  3. Intermediate examples (5-8) for JavaScript
  4. Intermediate examples (5-8) for Rust
  5. Advanced examples (9-12) for JavaScript
  6. Advanced examples (9-12) for Rust

Dependencies

Can Be Worked On Independently

Each example can be created independently as features are completed.

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgood first issueGood for newcomers

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions