mirror of
https://github.com/TryGhost/Ghost.git
synced 2024-12-24 19:33:02 +03:00
Added UpateCheckService usage example
This commit is contained in:
parent
74a949e38c
commit
d45ef018fe
@ -11,7 +11,56 @@ or
|
||||
|
||||
|
||||
## Usage
|
||||
Check the UpdateCheckService's constructor JSDoc for the list of available parameters. This is how the service is initialized in Ghost:
|
||||
```js
|
||||
const api = require('./api').v2;
|
||||
const GhostMailer = require('./services/mail').GhostMailer;
|
||||
const config = require('../shared/config');
|
||||
const urlUtils = require('./../shared/url-utils');
|
||||
|
||||
const i18n = require('../shared/i18n');
|
||||
const logging = require('../shared/logging');
|
||||
const request = require('./lib/request');
|
||||
const ghostVersion = require('./lib/ghost-version');
|
||||
const UpdateCheckService = require('@tryghost/update-check-service');
|
||||
|
||||
const updateChecker = new UpdateCheckService({
|
||||
api: {
|
||||
settings: {
|
||||
read: api.settings.read,
|
||||
edit: api.settings.edit
|
||||
},
|
||||
posts: {
|
||||
browse: api.posts.browse
|
||||
},
|
||||
users: {
|
||||
browse: api.users.browse
|
||||
},
|
||||
notifications: {
|
||||
add: api.notifications.add
|
||||
}
|
||||
},
|
||||
config: {
|
||||
mail: config.get('mail'),
|
||||
env: config.get('env'),
|
||||
databaseType: config.get('database').client,
|
||||
checkEndpoint: config.get('updateCheck:url'),
|
||||
isPrivacyDisabled: config.isPrivacyDisabled('useUpdateCheck'),
|
||||
notificationGroups: config.get('notificationGroups'),
|
||||
siteUrl: urlUtils.urlFor('home', true),
|
||||
forceUpdate: config.get('updateCheck:forceUpdate'),
|
||||
ghostVersion: ghostVersion.original
|
||||
},
|
||||
i18n,
|
||||
logging,
|
||||
request,
|
||||
sendEmail: ghostMailer.send
|
||||
});
|
||||
|
||||
// run the update check with
|
||||
|
||||
updateChecker.check();
|
||||
```
|
||||
|
||||
## Develop
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user