synergy-serial/index.d.ts

Generate a Synergy serial code.

declare interface Options {
    /**
     * The name of the user.
    */
    name?: string

    /**
     * The user limit.
    */
    userLimit?: number

    /**
     * The email of the user.
    */
    email?: string

    /**
     * The business of the user.
    */
    business?: string

    /**
     * The edition of the software.
    */
    edition?: string

    /**
     * The version of the key. Version 1 works on Synergy v1 and version 2 works on Synergy v1 (recent versions), v2 and v3 until v3.0.75 RC3. Version 3 works on at least 3.0.75 RC3 and later.
    */
    version?: number

    /**
     * When `version: 3`, the unix timestamp (in seconds) of when the key expiration warning should appear.
     */
    warningTime?: number

    /**
     * When `version: 3`, the unix timestamp (in seconds) of when the key should expire.
     */
    expirationTime?: number
}

/**
 * Generate a Synergy serial code.
 * @param options The metadata to encode in the serial code.
 * @example
 * ```
 * const synergySerial = require("synergy-serial")
 *
 * synergySerial();
 * //=> '7B76313B70726F3B4C7563792043616E6E6F6E3B39393B6E6F68406261767570617A692E70773B4C7563792043616E6E6F6E3B303B307D'
 *
 * synergySerial({name: "Humairaa Novak", userLimit: 99, email: "angZh@example.com"})
 * //=> '7B76313B70726F3B48756D6169726161204E6F76616B3B39393B616E675A68406578616D706C652E636F6D3B48756D6169726161204E6F76616B3B303B307D'
 *
 * synergySerial({name: "Humairaa Novak", userLimit: 99, email: "angZh@example.com", version: 2, edition: "pro"})
 * //=> '7B76323B6D61696E74656E616E63653B70726F3B48756D6169726161204E6F76616B3B39393B616E675A68406578616D706C652E636F6D3B48756D6169726161204E6F76616B3B303B307D'
 * ```
*/
declare function synergySerial(options?: Options): string;

export = synergySerial;