biketag/dist/common/methods.d.ts

The Javascript client API for BikeTag Games

import { AccessToken, ClientKey, ImgurCredentials, SanityCredentials, Credentials, BikeTagCredentials, Payload, BikeTagConfiguration } from './types';
import { default as FormData } from 'form-data';
import { default as TinyCache } from 'tinycache';
import { Tag, Game, Player, Ambassador, Setting, Achievement } from './schema';
import { ApiAvailability } from './enums';

export declare const putCacheIfExists: (key: string, value: any, cache?: typeof TinyCache) => void;
export declare const getCacheIfExists: (key: string, cache?: typeof TinyCache) => any;
export declare const isImageUrl: (payload: string | Payload) => boolean;
export declare const createForm: (payload: string | Payload) => FormData;
export declare const hasAccessToken: (arg: unknown) => arg is AccessToken;
export declare const hasClientKey: (arg: unknown) => arg is ClientKey;
export declare const constructTagNumberSlug: (number: number, game?: string) => string;
export declare const isImgurCredentials: (credentials: ImgurCredentials) => boolean;
export declare const isImgurApiReady: (credentials: ImgurCredentials) => ApiAvailability;
export declare const isSanityCredentials: (credentials: SanityCredentials) => boolean;
export declare const isSanityApiReady: (credentials: SanityCredentials) => ApiAvailability;
export declare const isBikeTagCredentials: (credentials: BikeTagCredentials | Credentials) => boolean;
export declare const isBikeTagApiReady: (credentials: BikeTagCredentials | Credentials) => ApiAvailability;
export declare const isBikeTagConfiguration: (credentials: BikeTagConfiguration) => boolean;
export declare const createImgurCredentials: (credentials: Partial<ImgurCredentials>, defaults?: Partial<ImgurCredentials>) => ImgurCredentials;
export declare const assignImgurCredentials: (credentials: ImgurCredentials, defaults?: Partial<ImgurCredentials>) => ImgurCredentials;
export declare const createSanityCredentials: (credentials: Partial<SanityCredentials>, defaults?: Partial<SanityCredentials>) => SanityCredentials;
export declare const assignSanityCredentials: (credentials: SanityCredentials, defaults?: Partial<SanityCredentials>) => SanityCredentials;
export declare const createBikeTagCredentials: (credentials: Partial<BikeTagCredentials>, defaults?: Partial<BikeTagCredentials>) => BikeTagCredentials;
export declare const assignBikeTagCredentials: (credentials: Credentials, defaults?: Partial<Credentials>) => BikeTagCredentials;
export declare const assignBikeTagConfiguration: (config: BikeTagConfiguration, defaults?: Partial<BikeTagConfiguration>) => BikeTagConfiguration;
export declare const isBikeTagData: (biketag: Partial<Tag>) => boolean;
export declare const isGameData: (ambassador: Partial<Game>) => boolean;
export declare const isPlayerData: (player: Partial<Player>) => boolean;
export declare const isAmbassadorData: (ambassador: Partial<Ambassador>) => boolean;
export declare const isSettingData: (setting: Partial<Setting>) => boolean;
export declare const isAchievementData: (achievement: Partial<Achievement>) => boolean;
export declare const sortTags: (tags: Tag[], sort?: string, limit?: number, time?: string) => Tag[];
export declare const sortPlayers: (players: Player[], sort?: string, limit?: number) => Player[];
export declare const sortAmbassadors: (ambassadors: Ambassador[], sort?: string, limit?: number) => Ambassador[];
export declare const sortSettings: (settings: Setting[], sort?: string, limit?: number) => Setting[];
export declare const sortAchievements: (achievements: Achievement[], sort?: string, limit?: number) => Achievement[];
export declare const getGameAlbumFromCache: (gameAlbumHash: string, cache?: typeof TinyCache, fallback?: any, useCache?: boolean) => Promise<any>;