query-builder examples

Creating a query string with filters

queryFor('users').include('posts').filter('creator').contains('bob').toString()
>> /users?include[]=posts&filter{creator.contains}=bob

Filtering on sideloaded data

queryFor('users').include('groups.*').filter('groups|name').icontains('h').toString()
>> ​​​​​/users?include[]=groups.*&filter{groups|name.icontains}=h​​​​​

Including only a subset of data

queryFor('users', 1).exclude('*').include('name').toString()
>> /users/1/?exclude[]=*&include[]=name

Sorting

queryFor('users').sort('name').sort('groups.name').toString()
>> /users/?sort[]=name&sort[]=groups.name

Nested accessors

queryFor('stacks').include('creator.', ['profile.', 'roles.']).toString()
>> ​​​​​/stacks?include[]=creator.&include[]=creator.profile.&include[]=creator.roles.