#7 TypeScript Definition Not Included

Author: EddyVerbruggen

firebase-common.d.ts

@@ -0,0 +1,48 @@
+declare module "nativescript-plugin-firebase" {
+
+    /**
+     * The allowed values for LoginOptions.type.
+     */
+    enum LoginType {
+      /**
+       * No further data is required.
+       */
+      ANONYMOUS,
+      /**
+       * This requires you to pass in email and password properties as well.
+       */
+      PASSWORD
+    }
+    
+    /**
+     * The allowed values for QueryOptions.orderBy.type.
+     */
+    enum QueryOrderByType {
+      KEY,
+      VALUE,
+      CHILD,
+      PRIORITY    
+    }
+
+    /**
+     * The allowed values for QueryOptions.range.type.
+     */
+    enum QueryRangeType {
+      START_AT,
+      END_AT,
+      EQUAL_TO   
+    }
+
+    /**
+     * The allowed values for QueryOptions.limit.type.
+     */
+    enum QueryLimitType {
+      FIRST,
+      LAST
+    }
+
+    /**
+     * Logout of the Firebase instance you previously logged in to.
+     */
+    function logout(): void;
+}

firebase.d.ts

@@ -0,0 +1,93 @@
+/// <reference path="firebase-common.d.ts"/>
+declare module "nativescript-plugin-firebase" {
+
+    /**
+     * The options object passed into the init function.
+     */
+    export interface InitOptions {
+      /**
+       * The endpoint of your firebase instance.
+       */
+      url: string;
+    }
+
+    /**
+     * The options object passed into the query function.
+     */
+    export interface QueryOptions {
+      /**
+       * How you'd like to sort the query result.
+       */
+      orderBy: {
+        type: QueryOrderByType;
+        /**
+         * mandatory when type is QueryOrderByType.CHILD
+         */
+        value?: string;
+      };
+
+      /**
+       * You can further restrict the returned results by specifying restrictions.
+       */
+      range?: {
+        type: QueryRangeType;
+        value: string;
+      }
+
+      /**
+       * You can limit the number of returned rows if you want to.
+       */
+      limit?: {
+        type: QueryLimitType;
+        value: number;
+      };
+    }
+
+    /**
+     * The options object passed into the login function.
+     */
+    export interface LoginOptions {
+      type: LoginType;
+      email?: string;
+      password?: string;
+    }
+
+    /**
+     * The returned object from the login function.
+     */
+    export interface LoginResult {
+      uid: string;
+      provider: LoginType;
+      expiresAtUnixEpochSeconds: number;
+      profileImageURL?: string;
+      token: string;
+    }
+
+    /**
+     * The options object passed into the createUser function.
+     */
+    export interface CreateUserOptions {
+      email: string;
+      password: string;
+    }
+    
+    /**
+     * The returned object in the callback handlers
+     * of the addChildEventListener and addValueEventListener functions.
+     */
+    export interface FBData {
+      type: string;
+      key: string;
+      value: any;
+    }
+
+    export function init(options : InitOptions): Promise<any>;
+    export function login(options : LoginOptions): Promise<LoginResult>;
+    export function createUser(options : CreateUserOptions): string;
+    export function push(path: string, value: any): void;
+    export function setValue(path: string, value: any): void;
+    export function remove(path: string): void;
+    export function query(onValueEvent: (data: FBData) => void, path: string, options: QueryOptions): void;
+    export function addChildEventListener(onChildEvent: (data: FBData) => void, path: string): void;
+    export function addValueEventListener(onValueEvent: (data: FBData) => void, path: string): void;
+}