vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2026-08-12 13:00:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #28295 from Knuddels/master

Browse Source 
updated knuddels api and fixed backwards compat issues
This commit is contained in:
Daniel Rosenwasser
2018-08-24 10:29:11 -07:00
committed by GitHub
parent d244a50c66 9945f5b4c2
commit 2f2fbf30c9
1 changed files with 57 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files
types/knuddels-userapps-api/index.d.ts
Vendored
+57 -15
View File
@@ -1,25 +1,35 @@
// Type definitions for Knuddels UserApps API 1.00108823
// Type definitions for Knuddels UserApps API 1.00109481
// Project: https://developer.knuddels.de
// Definitions by: Knuddels GmbH & Co. KG <https://github.com/Knuddels>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// JSON definition
export interface Json {
[x: string]: string | number | boolean | Date | Json | JsonArray;
}
export interface JsonArray extends Array<string | number | boolean | Date | Json | JsonArray> { }
// serializable objects (for persistence)
// helper types
export type JsonData = string | number | boolean | Date | Json | JsonArray;
export type KnuddelsJsonData = string | number | boolean | Date | KnuddelsJson | KnuddelsJsonArray | KnuddelsSerializable;
export type KnuddelsSerializable = string | number | boolean | User | BotUser;
export interface KnuddelsJson {
[x: string]: string | number | boolean | Date | KnuddelsJson | KnuddelsJsonArray | KnuddelsSerializable;
}
export interface KnuddelsJsonArray extends Array<string | number | boolean | Date | KnuddelsJson | KnuddelsJsonArray | KnuddelsSerializable> { }
// "data" that may be send between apps and between server and client
export type KnuddelsEvent = string | Json | KnuddelsEventArray;
export interface KnuddelsEventArray extends Array<string | KnuddelsEvent | KnuddelsEventArray> { }
// helper interfaces
declare global {
interface Json {
[x: string]: JsonData;
}
interface KnuddelsJson {
[x: string]: KnuddelsJsonData;
}
interface JsonArray extends Array<JsonData> {
}
interface KnuddelsJsonArray extends Array<KnuddelsJsonData> {
}
interface KnuddelsEventArray extends Array<string | Json | KnuddelsEventArray> {
}
}
// Apps API
declare global {
/**
* @see https://developer.knuddels.de/docs/classes/App.html
@@ -254,6 +264,13 @@ declare global {
width: number,
height: number
): AppContent;
/**
* @see https://developer.knuddels.de/docs/classes/AppContent.html#method_headerbarContent
*/
static headerbarContent(
htmlFile: HTMLFile,
height: number
): AppContent;
/**
* @see https://developer.knuddels.de/docs/classes/AppContent.html#method_sendEvent
*/
@@ -426,6 +443,14 @@ declare global {
* @see https://developer.knuddels.de/docs/classes/AppPersistence.html
*/
class AppPersistence extends Persistence {
/**
* @see https://developer.knuddels.de/docs/classes/AppPersistence.html#method_getDatabaseFileSize
*/
getDatabaseFileSize(): number;
/**
* @see https://developer.knuddels.de/docs/classes/AppPersistence.html#method_getDatabaseFileSizeLimit
*/
getDatabaseFileSizeLimit(): number;
}
/**
@@ -493,6 +518,10 @@ declare global {
* @see https://developer.knuddels.de/docs/classes/AppViewMode.html#property_Popup
*/
static readonly Popup: AppViewMode;
/**
* @see https://developer.knuddels.de/docs/classes/AppViewMode.html#property_Headerbar
*/
static readonly Headerbar: AppViewMode;
}
/**
@@ -1597,6 +1626,18 @@ declare global {
* @see https://developer.knuddels.de/docs/classes/KnuddelsServer.html
*/
class KnuddelsServer {
/**
* @see https://developer.knuddels.de/docs/classes/KnuddelsServer.html#method_execute
*/
static execute(
fileName: string
): void;
/**
* @see https://developer.knuddels.de/docs/classes/KnuddelsServer.html#method_listFiles
*/
static listFiles(
path: string
): string[];
/**
* @see https://developer.knuddels.de/docs/classes/KnuddelsServer.html#method_getDefaultBotUser
*/
@@ -2269,6 +2310,7 @@ declare global {
parameters?: {
labelMapping?: { [minValue: string]: string };
ascending?: boolean;
sortIndex?: number;
}
): Toplist;
}