Merge pull request #13 from rundef/master

Add PaginatorMeta class

README.md

@@ -17,53 +17,62 @@ Paginator library in NodeJS to facilitate REST pagination
 
 ### Installation
 
-    $ npm install --save  @ssense/node-paginator
+```bash
+npm install --save @ssense/node-paginator
+```
 
 ### Usage
 
-    import { Paginator } from '@ssense/node-paginator';
-
-    const items = ['item1', 'item2', 'item3']; // from your DB returned collection...
-    const perPage = 1;
-    const currentPage = 2;
-    const paginator: Paginator = new Paginator(items, items.length, perPage, currentPage);
-
-    // Transform paginator to object, use this as rour REST response
-    const paginated = paginator.transform();
-
-    console.log(paginated);
-    /*
-    output
-    {
-        total: 3,
-        per_page: 1,
-        current_page: 2,
-        last_page: 3,
-        from: 2,
-        to: 4,
-        links:{
-            previous: '/?page=1&foo=bar#foobar',
-            current: '/?page=2&foo=bar#foobar',
-            next: '/?page=3&foo=bar#foobar'
-        },
-        data: [ 'item1', 'item2', 'item3' ]
-    }
-    */
+```js
+import { Paginator } from '@ssense/node-paginator';
 
+const items = ['item1', 'item2', 'item3']; // from your DB returned collection...
+const perPage = 1;
+const currentPage = 2;
+const paginator: Paginator = new Paginator(items, items.length, perPage, currentPage);
+
+// Transform paginator to object, use this as rour REST response
+const paginated = paginator.transform();
+
+console.log(paginated);
+/*
+output
+{
+    total: 3,
+    per_page: 1,
+    current_page: 2,
+    last_page: 3,
+    from: 2,
+    to: 4,
+    links:{
+        previous: '/?page=1&foo=bar#foobar',
+        current: '/?page=2&foo=bar#foobar',
+        next: '/?page=3&foo=bar#foobar'
+    },
+    data: [ 'item1', 'item2', 'item3' ]
+}
+*/
+```
 
 ### Tips and tricks
 #### Append queries string to URL
-    // Append one query string to URL
-    paginator.append('key', 'value');
-
-    // Appends multiple queries to URL
-    paginator.appends({
-        foo: 'bar'
-    });
+
+```js
+// Append one query string to URL
+paginator.append('key', 'value');
+
+// Appends multiple queries to URL
+paginator.appends({
+    foo: 'bar'
+});
+```
 
 #### Add fragment to URL 
-    // Add foobar fragment to URL
-    paginator.fragment('foobar');
+
+```js
+// Add foobar fragment to URL
+paginator.fragment('foobar');
+```
 
 ### License
 

src/Paginator.d.ts

@@ -1,3 +1,4 @@
+import { PaginatorMeta } from './PaginatorMeta';
 export declare type PaginatorInterface = {
     total: number;
     per_page: number;
@@ -19,13 +20,8 @@ export declare type PaginatorOptions = {
     fragment?: string;
     pageName?: string;
 };
-export declare class Paginator {
-    protected _hasMore: boolean;
+export declare class Paginator extends PaginatorMeta {
     protected _items: any[];
-    protected _total: number;
-    protected _lastPage: number;
-    protected _perPage: number;
-    protected _currentPage: number;
     protected _options: PaginatorOptions;
     protected _defaultOptions: PaginatorOptions;
     protected _pageName: string;
@@ -36,22 +32,9 @@ export declare class Paginator {
     fragment(fragment?: string): Paginator | string;
     protected buildFragment(): string;
     items(): any[];
-    total(): number;
-    lastPage(): number;
-    firstItem(): number;
-    lastItem(): number;
-    perPage(): number;
-    onFirstPage(): boolean;
-    currentPage(): number;
-    hasPages(): boolean;
-    hasMorePages(): boolean;
-    isEmpty(): boolean;
-    count(): number;
     url(page?: number): string;
     previousPageUrl(): string;
     nextPageUrl(): string;
-    protected setCurrentPage(currentPage: number): number;
-    protected isValidPageNumber(page: number): boolean;
     getPageName(): string;
     setPageName(name: string): Paginator;
     transform(): PaginatorInterface;

src/PaginatorMeta.d.ts

@@ -0,0 +1,30 @@
+export declare type MetaPaginatorInterface = {
+    total: number;
+    per_page: number;
+    current_page: number;
+    last_page: number;
+    from: number;
+    to: number;
+};
+export declare class PaginatorMeta {
+    protected _hasMore: boolean;
+    protected _total: number;
+    protected _lastPage: number;
+    protected _perPage: number;
+    protected _currentPage: number;
+    constructor(total: number, perPage: number, currentPage: number);
+    total(): number;
+    lastPage(): number;
+    firstItem(): number | void;
+    lastItem(): number;
+    perPage(): number;
+    isEmpty(): boolean;
+    onFirstPage(): boolean;
+    currentPage(): number;
+    hasPages(): boolean;
+    hasMorePages(): boolean;
+    count(): number;
+    protected setCurrentPage(currentPage: number): number;
+    protected isValidPageNumber(page: number): boolean;
+    transform(): MetaPaginatorInterface;
+}

src/index.d.ts

@@ -1 +1,2 @@
+export * from './PaginatorMeta';
 export * from './Paginator';