import File = require("vinyl");
import Through = require("through");

type Callback = (
    this: Through.ThroughStream,
    /** A vinyl file object */
    file: File & { named: string },
    // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
) => string | null | undefined | void;

/**
 * Give vinyl files arbitrary chunk names.
 *
 * @param opt A callback that returns a name of the given file
 */
declare function named(opt?: Callback): Through.ThroughStream;

export = named;