summaryrefslogtreecommitdiff
path: root/src/remote/activitypub/renderer/ordered-collection.ts
blob: 68870a0ecda741c3ee5dcad311387469b889fe45 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
/**
 * Render OrderedCollection
 * @param id URL of self
 * @param totalItems Total number of items
 * @param first URL of first page (optional)
 * @param last URL of last page (optional)
 * @param orderedItems attached objects (optional)
 */
export default function(id: string | null, totalItems: any, first?: string, last?: string, orderedItems?: object) {
	const page: any = {
		id,
		type: 'OrderedCollection',
		totalItems,
	};

	if (first) page.first = first;
	if (last) page.last = last;
	if (orderedItems) page.orderedItems = orderedItems;

	return page;
}