Client Configuration
This page outlines the various configuration options available when initializing the client. You can configure the client to suit your application's requirements.
Initialization
import { createClient } from 'secton';
const client = createClient({
apiKey: 'your-api-key',
baseURL: 'https://api.secton.org/v1',
timeout: 30000,
retries: 3,
debug: false,
});
Options
apiKey
string
–
Your Secton API key
baseURL
string
'https://api.secton.org/v1'
API base URL override
timeout
number
30000
Request timeout in milliseconds
retries
number
3
Number of retry attempts
debug
boolean
false
Enable debug logging
userAgent
string
'secton-sdk/1.0.0'
Custom user agent string
logLevel
object
{ error: true, warn: true, info: false, debug: false }
Logging levels configuration
Config Builder
Use the fluent configBuilder
for cleaner setup:
import { createClient, configBuilder } from 'secton';
const config = configBuilder()
.apiKey('your-api-key')
.baseURL('https://api.secton.org/v1')
.timeout(30000)
.retries(3)
.debug(false)
.userAgent('secton-sdk/1.0.0')
.logLevel({ error: true, warn: true, info: false, debug: false })
.build();
const client = createClient(config);
Environment Variables
The client can be configured through environment variables, providing flexibility across different environments:
SECTON_API_KEY=your-api-key
SECTON_BASE_URL=https://api.secton.org/v1
SECTON_TIMEOUT=30000
SECTON_DEBUG=true
These variables can be set in your development environment or CI/CD pipelines to manage configurations securely.
Last updated
Was this helpful?