overleaf/services/notifications/README.md

notifications-sharelatex
===============

An API for managing user notifications in ShareLaTeX


database indexes
================

For notification expiry to work, a TTL index on `notifications.expires` must be created:

```javascript
db.notifications.createIndex({expires: 1}, {expireAfterSeconds: 10})
```
create scaffolding base on tags repo 2016-01-14 12:35:16 +00:00			`notifications-sharelatex`
			`===============`

			`An API for managing user notifications in ShareLaTeX`
Add commentary on ttl index 2016-08-11 11:03:50 +00:00

			`database indexes`
			`================`

Change how notification expiry works Set the `expires` field to be a date in the future, after which the document should be removed. 2016-08-12 10:38:17 +00:00			For notification expiry to work, a TTL index on `notifications.expires` must be created:
Add commentary on ttl index 2016-08-11 11:03:50 +00:00
			```javascript
Change how notification expiry works Set the `expires` field to be a date in the future, after which the document should be removed. 2016-08-12 10:38:17 +00:00			`db.notifications.createIndex({expires: 1}, {expireAfterSeconds: 10})`
Add commentary on ttl index 2016-08-11 11:03:50 +00:00			```