go-limiter

Limiter Go SDK

Installation

go get github.com/microrg/go-limiter

Quick Usage

Default Backend

Initialize SDK with the managed storage backend

import (
    "github.com/microrg/go-limiter/limiter"
)

client := limiter.New("project-id").WithDefaultBackend("api-token")

S3 Backend (Deprecated)

Initialize SDK with a private S3 bucket storage

import (
    "github.com/microrg/go-limiter/limiter"
)

client := limiter.New("project-id").WithS3Backend("s3-bucket", "region", "access-key-id", "secret-access-key")

Available Methods

// Bind user to a plan
client.Bind("plan-name", "user-id")

// Check if a feature is within limit
if client.Feature("feature-name", "user-id") {
    // Pass
}

// Increment usage
client.Increment("feature-name", "user-id", 1)

// Decrement usage
client.Decrement("feature-name", "user-id", 1)

// Set usage to some value
client.Set("feature-name", "user-id", 5)

// Get feature matrix for the project
client.FeatureMatrix("user-id")

// Get feature usage for a user
client.Usage("user-id")