https://github.com/blackglory/geyser-js

🌲 The JavaScript SDK for Geyser
https://github.com/blackglory/geyser-js

browser esm library nodejs npm-package typescript

Last synced: 3 months ago
JSON representation

🌲 The JavaScript SDK for Geyser

• Host: GitHub
• URL: https://github.com/blackglory/geyser-js
• Owner: BlackGlory
• License: mit
• Created: 2021-03-17T16:36:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-07-22T14:17:48.000Z (12 months ago)
• Last Synced: 2025-09-29T03:46:25.300Z (9 months ago)
• Topics: browser, esm, library, nodejs, npm-package, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@blackglory/geyser-js
• Size: 1.48 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# geyser-js

## Install

```sh

npm install --save @blackglory/geyser-js

# or

yarn add @blackglory/geyser-js

```

## API

### GeyserClient

```ts

interface IRateLimiterConfig extends JSONObject {

  duration: number | null

  limit: number | null

}

interface IGeyserClientOptions {

  server: string

  timeout?: number

  retryIntervalForReconnection?: number

}

class GeyserClient {

  static create(options: IGeyserClientOptions): Promise

  close(): Promise

  getAllRateLimiterIds(signal?: AbortSignal): Promise

  getRateLimiter(

    rateLimiterId: string

  , signal?: AbortSignal

  ): Promise

  setRateLimiter(

    rateLimiterId: string

  , config: IRateLimiterConfig

  , signal?: AbortSignal

  ): Promise

  removeRateLimiter(rateLimiterId: string, signal?: AbortSignal): Promise

  /**

   * 重置速率限制器的状态.

   * 

   * @throws {RateLimiterNotFound}

   */

  resetRateLimiter(rateLimiterId: string, signal?: AbortSignal): Promise

  /**

   * @throws {RateLimiterNotFound}

   */

  acquireToken(rateLimiterId: string, signal?: AbortSignal): Promise

}

/**

 * 速率限制器在未经配置的情况下, 相当于不存在.

 */

class RateLimiterNotFound extends CustomError {}

```