Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Type definitions missing #1

Open
motin opened this issue Sep 23, 2018 · 4 comments
Open

Type definitions missing #1

motin opened this issue Sep 23, 2018 · 4 comments

Comments

@motin
Copy link

motin commented Sep 23, 2018

First of all: thank you for this package!

I noticed that no type definitions are available for this package.

Here is a minimal stub rxdb-utils.d.ts used to be able to use the replication plugin without tslint errors:

import {Observable} from 'rxjs';

export declare class Replication {
  constructor(collections, remote, collectionNames?, direction?, options?);

  alive$: Observable<boolean>;

  connect(): Promise<any>;

  close(): Promise<any>;
}

declare module "rxdb/typings/rx-database" {
  interface RxDatabaseBase {
    replicate(remote, collectionNames?, direction?, options?): Replication;
  }
}
@rafamel
Copy link
Owner

rafamel commented Oct 15, 2018

Hi @motin, thanks for the issue. It's very likely that the whole module will be rewritten in ts for the next major version.

@psolom
Copy link
Contributor

psolom commented Oct 25, 2018

Do you have any ideas concerning the next major version release date?

@rafamel
Copy link
Owner

rafamel commented Oct 25, 2018

Hi @servocoder , there's currently no set date as I'm waiting for these two issues (1 & 2) to get through. If you're asking for Typescript support, PRs are welcomed and a minor version can be release before then if anyone contributes a complete typing file for all v1 plugins (all excluding views, select, and observables).

@beorn
Copy link

beorn commented Dec 6, 2020

Any update on TS rewrite plans? It looks like the two blocking issues have been completed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants