Module: packet/userid

packet/userid

Implementation of the User ID Packet (Tag 13)

A User ID packet consists of UTF-8 text that is intended to represent the name and email address of the key holder. By convention, it includes an RFC 2822 [RFC2822] mail name-addr, but there are no restrictions on its content. The packet length in the header specifies the length of the User ID.

new (require("packet/userid"))()

Source:

packet/userid.js, line 35

Source:

packet/userid.js, line 18

Requires

module:util

Members

userid :String

A string containing the user id. Usually in the form John Doe

Type:

String

Source:

packet/userid.js, line 40

Methods

read(input)

Parsing function for a user id packet (tag 13).

Parameters:

Name	Type	Description
`input`	String	payload of a tag 13 packet

Source:

packet/userid.js, line 47

write() → {String}

Creates a string representation of the user id packet

Source:

packet/userid.js, line 55

Returns:

string representation

Type: String