@mysql/xdevapi/types/test/DevAPI/CollectionAdd.test-d.ts

MySQL Connector/Node.js - A Node.js driver for MySQL using the X Protocol and X DevAPI.

/*
 * Copyright (c) 2022, 2023, Oracle and/or its affiliates.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License, version 2.0, as
 * published by the Free Software Foundation.
 *
 * This program is also distributed with certain software (including
 * but not limited to OpenSSL) that is licensed under separate terms,
 * as designated in a particular file or component or in included license
 * documentation.  The authors of MySQL hereby grant you an
 * additional permission to link the program and your derivative works
 * with the separately licensed software that they have included with
 * MySQL.
 *
 * Without limiting anything contained in the foregoing, this file,
 * which is part of MySQL Connector/Node.js, is also subject to the
 * Universal FOSS Exception, version 1.0, a copy of which can be found at
 * http://oss.oracle.com/licenses/universal-foss-exception.
 *
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License, version 2.0, for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301  USA
 */

import { expectType } from 'tsd';
import * as mysqlx from '../../';
import CollectionAdd from '../../lib/DevAPI/CollectionAdd';
import Result from '../../lib/DevAPI/Result';

async function test (): Promise<void> {
    // create a dummy session
    const session = await mysqlx.getSession('foo');
    // obtain a dummy schema
    const schema = session.getDefaultSchema();
    // obtain a dummy collection
    const collection = schema.getCollection('foo');
    // create a dummy statement
    const statement = collection.add({ name: 'foo' });

    // add()
    expectType<CollectionAdd>(statement.add('{ "name": "foo" }'));
    expectType<CollectionAdd>(statement.add('{ "name": "foo" }', '{ "name": "bar" }'));
    expectType<CollectionAdd>(statement.add(['{ "name": "foo" }']));
    expectType<CollectionAdd>(statement.add(['{ "name": "foo" }', '{ "name": "bar" }']));
    expectType<CollectionAdd>(statement.add(['{ "name": "foo" }', '{ "name": "bar" }'], '{ "name": "baz" }'));
    expectType<CollectionAdd>(statement.add(['{ "name": "foo" }', '{ "name": "bar" }'], ['{ "name": "baz" }', '{ "name": "qux" }']));
    expectType<CollectionAdd>(statement.add('{ "name": "foo" }').add('{ "name": "bar" }'));
    expectType<CollectionAdd>(statement.add('{ "name": "foo" }', '{ "name": "bar" }').add('{ "name": "baz" }'));
    expectType<CollectionAdd>(statement.add(['{ "name": "foo" }', '{ "name": "bar" }']).add(['{ "name": "baz" }']));
    expectType<CollectionAdd>(statement.add({ name: 'foo' }));
    expectType<CollectionAdd>(statement.add({ name: 'foo' }, { name: 'bar' }));
    expectType<CollectionAdd>(statement.add({ name: 'foo' }, { name: 'bar', child: { name: 'baz' } }));
    expectType<CollectionAdd>(statement.add({ name: 'foo' }, { name: 'bar', children: [{ name: 'baz' }] }));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo', child: { name: 'bar' } }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo', children: [{ name: 'bar' }] }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar' }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar', child: { name: 'bar' } }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar', children: [{ name: 'bar' }] }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar' }], { name: 'baz' }));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar' }], [{ name: 'baz' }, { name: 'qux' }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar' }], [{ name: 'baz' }, { name: 'qux', child: { name: 'quxx' } }]));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar' }], [{ name: 'baz' }, { name: 'qux', children: [{ name: 'quxx' }] }]));
    expectType<CollectionAdd>(statement.add({ name: 'foo' }).add({ name: 'bar' }));
    expectType<CollectionAdd>(statement.add({ name: 'foo' }, { name: 'bar' }).add({ name: 'baz' }));
    expectType<CollectionAdd>(statement.add([{ name: 'foo' }, { name: 'bar' }]).add([{ name: 'baz' }]));
    expectType<CollectionAdd>(statement.add({ bigInt: BigInt('18446744073709551615') }));

    // add() using JavaScript class instances
    class Doc {
        private readonly _name: string;

        constructor (name: string) {
            this._name = name;
        }
    }

    expectType<CollectionAdd>(statement.add(new Doc('foo')));
    expectType<CollectionAdd>(statement.add(new Doc('foo'), new Doc('bar')));
    expectType<CollectionAdd>(statement.add([new Doc('foo'), new Doc('bar')]));
    expectType<CollectionAdd>(statement.add([new Doc('foo'), new Doc('bar')], [new Doc('baz')]));

    // execute()
    expectType<Result>(await statement.execute());
}

void test();