add deprecated warnings

This commit is contained in:
blagoev 2017-09-12 20:38:43 +03:00
parent 3fbd1291e1
commit 115a2c9902
2 changed files with 29 additions and 3 deletions

20
lib/index.d.ts vendored
View File

@ -264,12 +264,25 @@ declare namespace Realm.Sync {
readonly server: string; readonly server: string;
readonly token: string; readonly token: string;
static adminUser(adminToken: string, server?: string): User; static adminUser(adminToken: string, server?: string): User;
static login(server: string, username: string, password: string): Promise<Realm.Sync.User>;
/**
* @deprecated, to be removed in future versions
*/
static login(server: string, username: string, password: string, callback: (error: any, user: User) => void): void; static login(server: string, username: string, password: string, callback: (error: any, user: User) => void): void;
static register(server: string, username: string, password: string): Promise<Realm.Sync.User>; static login(server: string, username: string, password: string): Promise<Realm.Sync.User>;
/**
* @deprecated, to be removed in future versions
*/
static register(server: string, username: string, password: string, callback: (error: any, user: User) => void): void; static register(server: string, username: string, password: string, callback: (error: any, user: User) => void): void;
static registerWithProvider(server: string, options: { provider: string, providerToken: string, userInfo: any }): Promise<Realm.Sync.User>; static register(server: string, username: string, password: string): Promise<Realm.Sync.User>;
/**
* @deprecated, to be removed in versions
*/
static registerWithProvider(server: string, options: { provider: string, providerToken: string, userInfo: any }, callback: (error: Error | null, user: User | null) => void): void; static registerWithProvider(server: string, options: { provider: string, providerToken: string, userInfo: any }, callback: (error: Error | null, user: User | null) => void): void;
static registerWithProvider(server: string, options: { provider: string, providerToken: string, userInfo: any }): Promise<Realm.Sync.User>;
logout(): void; logout(): void;
openManagementRealm(): Realm; openManagementRealm(): Realm;
retrieveAccount(provider: string, username: string): Promise<Account>; retrieveAccount(provider: string, username: string): Promise<Account>;
@ -377,6 +390,7 @@ declare namespace Realm.Sync {
function removeListener(regex: string, name: string, changeCallback: (changeEvent: ChangeEvent) => void): void; function removeListener(regex: string, name: string, changeCallback: (changeEvent: ChangeEvent) => void): void;
function setLogLevel(logLevel: 'all' | 'trace' | 'debug' | 'detail' | 'info' | 'warn' | 'error' | 'fatal' | 'off'): void; function setLogLevel(logLevel: 'all' | 'trace' | 'debug' | 'detail' | 'info' | 'warn' | 'error' | 'fatal' | 'off'): void;
function setFeatureToken(token: string): void; function setFeatureToken(token: string): void;
/** /**
* @deprecated, to be removed in 2.0 * @deprecated, to be removed in 2.0
*/ */

View File

@ -189,6 +189,10 @@ const staticMethods = {
data: username data: username
}; };
if (callback) {
const message = "register(..., callback) is now deprecated in favor of register(): Promise<User>. This function argument will be removed in future versions.";
(console.warn || console.log).call(console, message);
}
_authenticate(this, server, json, callback); _authenticate(this, server, json, callback);
}, },
@ -201,6 +205,10 @@ const staticMethods = {
data: username data: username
}; };
if (callback) {
const message = "login(..., callback) is now deprecated in favor of login(): Promise<User>. This function argument will be removed in future versions.";
(console.warn || console.log).call(console, message);
}
_authenticate(this, server, json, callback); _authenticate(this, server, json, callback);
}, },
@ -228,6 +236,10 @@ const staticMethods = {
json.user_info = options.userInfo; json.user_info = options.userInfo;
} }
if (callback) {
const message = "registerWithProvider(..., callback) is now deprecated in favor of registerWithProvider(): Promise<User>. This function argument will be removed in future versions.";
(console.warn || console.log).call(console, message);
}
_authenticate(this, server, json, callback); _authenticate(this, server, json, callback);
}, },