@collight/dns-sd
    Preparing search index...

    Interface ServiceOptions

    Options used to configure a service instance.

    interface ServiceOptions {
        disableIPv6?: boolean;
        host?: string;
        name: string;
        port: number;
        probe?: boolean;
        probeAutoResolve?: boolean;
        protocol?: string;
        subtypes?: string[];
        ttl?: number;
        txt?: Record<string, string | number | boolean | Buffer<ArrayBufferLike>>;
        type: string;
    }
    Index

    Properties

    disableIPv6? host? name port probe? probeAutoResolve? protocol? subtypes? ttl? txt? type

    Properties

    disableIPv6?: boolean

    Whether to disable publishing IPv6 addresses for this service.

    false
    host?: string

    The hostname of the machine offering the service.

    os.hostname()
    name: string

    The instance name of the service. This will be sanitized by replacing dots with dashes.

    'MyPrinter'
    port: number

    The port number on which the service is listening.

    probe?: boolean

    Whether to perform probing to detect name conflicts before publishing.

    true
    probeAutoResolve?: boolean

    Whether to automatically resolve name conflicts by appending a number to the service name.

    true
    protocol?: string

    The protocol used by the service, typically "tcp" or "udp".

    'tcp'
    subtypes?: string[]

    Optional list of subtype identifiers for selective discovery.

    ttl?: number

    The TTL (time to live) in seconds for the all records.

    The same TTL is set to all records (PTR, SRV, TXT, A, AAAA) for simplicity and compatibility.

    4500
    txt?: Record<string, string | number | boolean | Buffer<ArrayBufferLike>>

    Optional TXT record key-value pairs to advertise service metadata.

    type: string

    The service type (e.g., "http", "ipp"). Used to form the full service type domain.

    Settings

    Member Visibility

    On This Page

    Properties