@jsynple/core/dist/repositories/SynthesizersRepository.d.ts

All the core modules and types for the Synple application

import type { Requestable } from "../network/Api";
import type { Synthesizer, SynthesizerDescription } from "../types/Synthesizer";
import { Repository } from "./utils/Repository";
/**
 * This repository allows the querying of synthesizers. It does NOT however link any other resource
 * (eg cables or modules) to the provided synthesizer as it is supposed to be done in another layer
 * of services orchestrating the repositories correctly.
 * @author Vincent Courtois <courtois.vincent@outlook.com>
 */
export declare class SynthesizersRepository extends Repository<Synthesizer, SynthesizerDescription> {
    constructor(api: Requestable);
    /**
     * This method forbids any further user to update unnecessary fields on the synthesizer other than
     * its coordinates and zoom factor.
     *
     * @param synthesizer The synthesizer to update the coordinates from.
     * @returns the updated synthesizer after API query.
     */
    update(synthesizer: Synthesizer, token: string): Promise<Synthesizer>;
}