jsdoc/test/specs/documentation/restparams.js

'use strict';

describe('rest parameters', function() {
    var docSet = jasmine.getDocSetFromFile('test/fixtures/restparams.js');
    var setAdmins = docSet.getByLongname('setAdmins')[0];
    var setManagers = docSet.getByLongname('setManagers')[0];
    var setWidgetAccess = docSet.getByLongname('setWidgetAccess')[0];

    it('should automatically mark standalone rest parameters as repeatable', function() {
        var restParam = setAdmins.params[0];

        expect(restParam.name).toBe('users');
        expect(restParam.variable).toBe(true);
    });

    it('should automatically mark rest parameters as repeatable when they are mixed with other params', function() {
        var restParam = setWidgetAccess.params[1];

        expect(restParam.name).toBe('users');
        expect(restParam.variable).toBe(true);
    });

    it('should automatically mark rest parameters as repeatable when the function is assigned to a variable', function() {
        var restParam = setManagers.params[0];

        expect(restParam.name).toBe('users');
        expect(restParam.variable).toBe(true);
    });

    describe('ES2015 methods', function() {
        var docSet2 = jasmine.getDocSetFromFile('test/fixtures/restparams2.js');

        var addUsers = docSet2.getByLongname('Widget#addUsers')[0];

        it('should autodetect rest parameters', function() {
            expect(addUsers.params[0].variable).toBe(true);
        });
    });
});