-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
- Loading branch information
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import { Agenda } from "."; | ||
import { Document, Filter } from "mongodb"; | ||
/** | ||
* Cancels any jobs matching the passed MongoDB query, and removes them from the database. | ||
* @name Agenda#cancel | ||
* @function | ||
* @param query MongoDB query to use when cancelling | ||
* @caller client code, Agenda.purge(), Job.remove() | ||
*/ | ||
export declare const cancel: (this: Agenda, query: Filter<Document>) => Promise<number | undefined>; | ||
//# sourceMappingURL=cancel.d.ts.map |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
import { Agenda } from "."; | ||
/** Close the db and it's underlying connections | ||
* Only works if agenda was instantiated without preconfigured mongoDb instance. | ||
* If the mongoDb instance was supplied during instantiation or via agenda.mongo, this function will do nothing and return agenda anyway. | ||
* @name Agenda#close | ||
* @function | ||
* @param [option] {{ force: boolean }} Force close, emitting no events | ||
* | ||
* | ||
* @caller client code | ||
* | ||
* @link https://mongodb.github.io/node-mongodb-native/2.0/api/Db.html#close | ||
*/ | ||
export declare const close: (this: Agenda, option?: { | ||
force: boolean; | ||
} | undefined) => Promise<Agenda>; | ||
//# sourceMappingURL=close.d.ts.map |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import { Job } from "../job"; | ||
import { Agenda } from "."; | ||
/** | ||
* Given a name and some data, create a new job | ||
* @name Agenda#create | ||
* @function | ||
* @param name name of job | ||
* @param data data to set for job | ||
*/ | ||
export declare const create: (this: Agenda, name: string, data: any) => Job; | ||
//# sourceMappingURL=create.d.ts.map |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
import { AnyError, Collection, MongoClientOptions } from "mongodb"; | ||
import { Agenda } from "."; | ||
/** | ||
* Connect to the spec'd MongoDB server and database. | ||
* | ||
* NOTE: | ||
* If `url` includes auth details then `options` must specify: { 'uri_decode_auth': true }. This does Auth on | ||
* the specified database, not the Admin database. If you are using Auth on the Admin DB and not on the Agenda DB, | ||
* then you need to authenticate against the Admin DB and then pass the MongoDB instance into the constructor | ||
* or use Agenda.mongo(). If your app already has a MongoDB connection then use that. ie. specify config.mongo in | ||
* the constructor or use Agenda.mongo(). | ||
* @name Agenda#database | ||
* @function | ||
* @param url MongoDB server URI | ||
* @param [collection] name of collection to use. Defaults to `agendaJobs` | ||
* @param [options] options for connecting | ||
* @param [cb] callback of MongoDB connection | ||
*/ | ||
export declare const database: (this: Agenda, url: string, collection?: string | undefined, options?: MongoClientOptions, cb?: ((error: AnyError | undefined, collection: Collection<any> | null) => void) | undefined) => Agenda | void; | ||
//# sourceMappingURL=database.d.ts.map |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
import { AnyError, Collection } from "mongodb"; | ||
import { Agenda } from "."; | ||
/** | ||
* Setup and initialize the collection used to manage Jobs. | ||
* @name Agenda#dbInit | ||
* @function | ||
* @param collection name or undefined for default 'agendaJobs' | ||
* @param [cb] called when the db is initialized | ||
*/ | ||
export declare const dbInit: (this: Agenda, collection?: string, cb?: ((error: AnyError | undefined, collection: Collection<any> | null) => void) | undefined) => void; | ||
//# sourceMappingURL=db-init.d.ts.map |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
import { Agenda } from "."; | ||
/** | ||
* Set the default concurrency for each job | ||
* @name Agenda#defaultConcurrency | ||
* @function | ||
* @param concurrency default concurrency | ||
*/ | ||
export declare const defaultConcurrency: (this: Agenda, concurrency: number) => Agenda; | ||
//# sourceMappingURL=default-concurrency.d.ts.map |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.