Categorygithub.com/configcat/go-sdk/v5
modulepackage
5.1.0
Repository: https://github.com/configcat/go-sdk.git
Documentation: pkg.go.dev

# README

ConfigCat SDK for Go

https://configcat.com

ConfigCat SDK for Go provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Dashboard even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

Build Status Go Report Card codecov GoDoc License

Getting started

1. Install the package with go

go get github.com/configcat/go-sdk/v5

2. Go to Connect your application tab to get your SDK Key:

SDK-KEY

3. Import the ConfigCat client package to your application

import "github.com/configcat/go-sdk/v5"

4. Create a ConfigCat client instance:

client := configcat.NewClient("#YOUR-SDK-KEY#")

5. Get your setting value:

isMyAwesomeFeatureEnabled, ok := client.GetValue("isMyAwesomeFeatureEnabled", false).(bool)
if ok && isMyAwesomeFeatureEnabled {
    DoTheNewThing()
} else {
    DoTheOldThing()
}

Or use the async SDKs:

client.GetValueAsync("isMyAwesomeFeatureEnabled", false, func(result interface{}) {
    isMyAwesomeFeatureEnabled, ok := result.(bool)
    if ok && isMyAwesomeFeatureEnabled {
        DoTheNewThing()
    } else {
        DoTheOldThing()
    }
})

6. Close ConfigCat client on application exit:

client.Close()

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to the getValue() function.

Read more about Targeting here.

user := configcat.NewUser("#USER-IDENTIFIER#")

isMyAwesomeFeatureEnabled, ok := client.GetValueForUser("isMyAwesomeFeatureEnabled", user, false).(bool)
if ok && isMyAwesomeFeatureEnabled {
    DoTheNewThing()
} else {
    DoTheOldThing()
}

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.

Need help?

https://configcat.com/support

Contributing

Contributions are welcome.

About ConfigCat

# Functions

AutoPoll creates an auto polling refresh mode.
AutoPollWithChangeListener creates an auto polling refresh mode with change listener callback.
DefaultLogger creates the default logger with specified log level (logrus.New()).
LazyLoad creates a lazy loading refresh mode.
ManualPoll creates a manual loading refresh mode.
NewClient initializes a new ConfigCat Client with the default configuration.
NewCustomClient initializes a new ConfigCat Client with advanced configuration.
NewUser creates a new user object.
NewUserWithAdditionalAttributes creates a new user object with additional attributes.

# Constants

Failure indicates that the current configuration fetch is failed.
Fetched indicates that a new configuration was fetched.
Define the logrus log levels.
Define the logrus log levels.
Define the logrus log levels.
Define the logrus log levels.
Define the logrus log levels.
Define the logrus log levels.
Define the logrus log levels.
NotModified indicates that the current configuration is not modified.

# Structs

Client is an object for handling configurations provided by ConfigCat.
ClientConfig describes custom configuration options for the Client.
User is an object containing attributes to properly identify a given user for rollout evaluation.

# Interfaces

ConfigCache is a cache API used to make custom cache implementations.
Logger defines the interface this library logs with.
RefreshMode is a base for refresh mode configurations.

# Type aliases

No description provided by the author