{"_id":"566a2fdf0405980d001f40af","category":{"_id":"5667789f575ec10d00640b80","pages":["56677ec5be6e390d004eb465","566780b78f1eec0d00d9e391","566791b8ee1dbf0d008f611b","566794b305cae40d00bea738","5667957306039e0d00c4eba7","5668d4e1f921480d00a34555","5668d76dc3de130d004416ba","5668d8b7d000ff1700ca477a","5668d97b07625117002c2727","5668dcf02961f917006ada2c","566a1c83e233063900c10f80","566a1eaed000ff1700ca4941","566a1ec007625117002c29e9","566a2391434e53390069d8e3","566a26b455e4b32100935f47","566a2716f625510d000e55e6","566a29cbf625510d000e55e9","566a2fdf0405980d001f40af","566a30451766bf0d00e737bd","566a328bf625510d000e55f1","566a34561e08750d00a0c497","566a348d1766bf0d00e737c4","566b92b471dc6a0d00b2493c"],"version":"5667237fee53940d00516247","__v":23,"project":"5667237eee53940d00516244","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-12-09T00:41:03.215Z","from_sync":false,"order":1,"slug":"api-reference","title":"API Reference"},"user":"56672364f672550d00085227","version":{"_id":"5667237fee53940d00516247","__v":4,"project":"5667237eee53940d00516244","createdAt":"2015-12-08T18:37:51.439Z","releaseDate":"2015-12-08T18:37:51.439Z","categories":["56672380ee53940d00516248","5667789f575ec10d00640b80","566779078c573e0d00023d96","56677e2bbe6e390d004eb463"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"project":"5667237eee53940d00516244","githubsync":"","__v":1,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-12-11T02:07:27.637Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":14,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"This type of sort will always do a string based sort. To do a number based sort you can use the Array(Object) option described next.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"String Parameters\"\n}\n[/block]\nThe .orderBy() function requires at least one parameter. Each parameter is the name of the field to perform an ascending sort on. You can perform a descending sort using the Array(Object) parameter described next. \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"orderBy( string, string , string, ...) \",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"orderBy(field: string, ...fields: string[]): jinqJs;\",\n      \"language\": \"javascript\",\n      \"name\": \"TypeScript\"\n    }\n  ]\n}\n[/block]\n\n[block:embed]\n{\n  \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?url=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fmbcg0k52%2F&src=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fmbcg0k52%2Fembedded%2F&type=text%2Fhtml&key=02466f963b9b4bb8845a05b53d3235d7&schema=jsfiddle\\\" width=\\\"600\\\" height=\\\"400\\\" scrolling=\\\"no\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\",\n  \"url\": \"https://jsfiddle.net/tford/mbcg0k52/\",\n  \"title\": \"jinqJs - JSFiddle\",\n  \"favicon\": \"https://jsfiddle.net/favicon.png\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Array Of Objects Paremeter\"\n}\n[/block]\nThe .orderBy() function can except a single parameter of an array of objects. The field property can take a positional number to sort on.  This is helpful when sorting on key value collections or plain arrays. Each orderBy object must be in the following format:\n{\n     field: ‘Field’,        *<= (Optional, The string name or field position of the field to sort on)*\n     sort: ‘asc|desc’   *<= (Optional)*\n}\n\n*Note, if a field has a positional value then all fields must use a positional value too.* \n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"orderBy( Array( Object, Object, Object, … ) )\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"interface orderByParameter {\\n  field?: number | string;\\n  sort?: string;\\n}\\n\\norderBy(orderByParams: orderByParameter[]): jinqJs;\",\n      \"language\": \"javascript\",\n      \"name\": \"TypeScript\"\n    }\n  ]\n}\n[/block]\n\n[block:embed]\n{\n  \"html\": \"<iframe class=\\\"embedly-embed\\\" src=\\\"//cdn.embedly.com/widgets/media.html?url=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fx877amwL%2F&src=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fx877amwL%2Fembedded%2F&type=text%2Fhtml&key=02466f963b9b4bb8845a05b53d3235d7&schema=jsfiddle\\\" width=\\\"600\\\" height=\\\"400\\\" scrolling=\\\"no\\\" frameborder=\\\"0\\\" allowfullscreen></iframe>\",\n  \"url\": \"https://jsfiddle.net/tford/x877amwL/\",\n  \"title\": \"jinqJs - JSFiddle\",\n  \"favicon\": \"https://jsfiddle.net/favicon.png\"\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var result = new jinqJs()\\n                 .from([1,6,3,5,4,2])\\n                 .orderBy([{sort: 'desc'}])\\n                 .select();\\n\\n/* result:  [6,5,4,3,2,1] */\",\n      \"language\": \"javascript\",\n      \"name\": \"Sample Simple Array\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"var result = new jinqJs()\\n                 .from([{\\\"john\\\" : 28},{ \\\"bob\\\": 34},{ \\\"joe\\\" : 4}])\\n                 .orderBy([{field: 0}])\\n                 .select([{field: 0, text: 'Ages'}]);\\n\\n/* result:  [{Ages: 4}, {Ages: 28}, {Ages: 34}] */\",\n      \"language\": \"javascript\",\n      \"name\": \"Sample Complex Array\"\n    }\n  ]\n}\n[/block]","excerpt":"The .orderBy() function can be used to sort fields in ascending and descending order.","slug":"orderby","type":"fn","title":"orderBy"}

orderBy

The .orderBy() function can be used to sort fields in ascending and descending order.

[block:callout] { "type": "info", "body": "This type of sort will always do a string based sort. To do a number based sort you can use the Array(Object) option described next." } [/block] [block:api-header] { "type": "basic", "title": "String Parameters" } [/block] The .orderBy() function requires at least one parameter. Each parameter is the name of the field to perform an ascending sort on. You can perform a descending sort using the Array(Object) parameter described next. [block:code] { "codes": [ { "code": "orderBy( string, string , string, ...) ", "language": "javascript" } ] } [/block] [block:code] { "codes": [ { "code": "orderBy(field: string, ...fields: string[]): jinqJs;", "language": "javascript", "name": "TypeScript" } ] } [/block] [block:embed] { "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?url=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fmbcg0k52%2F&src=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fmbcg0k52%2Fembedded%2F&type=text%2Fhtml&key=02466f963b9b4bb8845a05b53d3235d7&schema=jsfiddle\" width=\"600\" height=\"400\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>", "url": "https://jsfiddle.net/tford/mbcg0k52/", "title": "jinqJs - JSFiddle", "favicon": "https://jsfiddle.net/favicon.png" } [/block] [block:api-header] { "type": "basic", "title": "Array Of Objects Paremeter" } [/block] The .orderBy() function can except a single parameter of an array of objects. The field property can take a positional number to sort on. This is helpful when sorting on key value collections or plain arrays. Each orderBy object must be in the following format: { field: ‘Field’, *<= (Optional, The string name or field position of the field to sort on)* sort: ‘asc|desc’ *<= (Optional)* } *Note, if a field has a positional value then all fields must use a positional value too.* [block:code] { "codes": [ { "code": "orderBy( Array( Object, Object, Object, … ) )", "language": "javascript" } ] } [/block] [block:code] { "codes": [ { "code": "interface orderByParameter {\n field?: number | string;\n sort?: string;\n}\n\norderBy(orderByParams: orderByParameter[]): jinqJs;", "language": "javascript", "name": "TypeScript" } ] } [/block] [block:embed] { "html": "<iframe class=\"embedly-embed\" src=\"//cdn.embedly.com/widgets/media.html?url=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fx877amwL%2F&src=https%3A%2F%2Fjsfiddle.net%2Ftford%2Fx877amwL%2Fembedded%2F&type=text%2Fhtml&key=02466f963b9b4bb8845a05b53d3235d7&schema=jsfiddle\" width=\"600\" height=\"400\" scrolling=\"no\" frameborder=\"0\" allowfullscreen></iframe>", "url": "https://jsfiddle.net/tford/x877amwL/", "title": "jinqJs - JSFiddle", "favicon": "https://jsfiddle.net/favicon.png" } [/block] [block:code] { "codes": [ { "code": "var result = new jinqJs()\n .from([1,6,3,5,4,2])\n .orderBy([{sort: 'desc'}])\n .select();\n\n/* result: [6,5,4,3,2,1] */", "language": "javascript", "name": "Sample Simple Array" } ] } [/block] [block:code] { "codes": [ { "code": "var result = new jinqJs()\n .from([{\"john\" : 28},{ \"bob\": 34},{ \"joe\" : 4}])\n .orderBy([{field: 0}])\n .select([{field: 0, text: 'Ages'}]);\n\n/* result: [{Ages: 4}, {Ages: 28}, {Ages: 34}] */", "language": "javascript", "name": "Sample Complex Array" } ] } [/block]