incomplete information about peer IDs and metadata in docs

[teo1978]

At http://peerjs.com/docs/#api

In the API reference, this is said about the id parameter of the constructor:

[id]STRING Other peers can connect to this peer using the provided ID. If no ID is given, one will be generated by the brokering server. It's not recommended that you use this ID to identify peers, as it's meant to be used for brokering connections only. You're recommended to set the metadata option to send other identifying information.

You're recommended to set the metadata option: HOW? The docs of the metadata option say nothing about how you are supposed to use it to "send other identifying information" (whatever that means, which by the way is unclear too).

[ndac-todoroki]

Metadata is "data that provides information about other data". Wikipedia | Metadata

So I've thought anything is okay, like objects:

peer.connect(id, {
    metadata: {
        username: "ndac-todoroki",
        userid: "3cauilj1vbcsor"
    }
});

so you want to decide your own metadata key or something to identify one peer from another. But this is only how I use it...

So yes I agree with you. The documentation surely needs at least some kind of examples.