openblox/dist/config/config.d.ts

Roblox API Wrapper For Both Classic And OpenCloud APIs.

import { RobloxCookie } from "../http/http.utils";
import type { HttpAdapter } from "../http/httpAdapters";
import type { CacheAdapter } from "../cache/cacheAdapters/cacheAdapters";
import type { ObjectPrettify } from "typeforge";
export type OpenbloxConfig<Cookie = FormattedRobloxCookie> = ObjectPrettify<{
    cookie?: Cookie;
    cloudKey?: string;
    http?: {
        adapter?: HttpAdapter;
        csrfMaxAttempts?: number;
        csrfToken?: string;
        polling?: {
            disabled?: boolean;
            iterations?: number;
            multiplyer?: number;
            retryOffset?: number;
            debugMessages?: boolean;
        };
    };
    cache?: ReturnType<CacheAdapter<any, any>>[];
}>;
export declare const defaultOpenbloxConfig: OpenbloxConfig;
export type FormattedRobloxCookie = `.ROBLOSECURITY=${RobloxCookie}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;`;
export declare const setDefaultOpenbloxConfig: (newConfig: OpenbloxConfig & {
    _phantom_isValid: true;
}) => void;
export declare const createOpenbloxConfig: (newConfig: OpenbloxConfig<RobloxCookie>) => {
    cookie?: `.ROBLOSECURITY=_|WARNING:-DO-NOT-SHARE-THIS.--Sharing-this-will-allow-someone-to-log-in-as-you-and-to-steal-your-ROBUX-and-items.|${string}; RBXEventTrackerV2=CreateDate=1/1/1 1:1:1 PM&rbxid=1&browserid=1;` | undefined;
    cloudKey?: string | undefined;
    http?: {
        adapter?: HttpAdapter | undefined;
        csrfMaxAttempts?: number | undefined;
        csrfToken?: string | undefined;
        polling?: {
            disabled?: boolean | undefined;
            iterations?: number | undefined;
            multiplyer?: number | undefined;
            retryOffset?: number | undefined;
            debugMessages?: boolean | undefined;
        } | undefined;
    } | undefined;
    cache?: {
        name: string;
        get: (key: string) => any;
        set: (settings: any, key: string, value: any) => void;
    }[] | undefined;
} & {
    _phantom_isValid: true;
};