index.md

layout	menu_item	title	description	return_to	sections
default	api	Mailmap	Version 0.26.1	API Documentation Index /api/	create fromBuffer fromRepository #addEntry #resolve #resolveSignature #create #fromBuffer #fromRepository #addEntry #resolve #resolveSignature

Mailmap.create AsyncExperimental

Mailmap.create().then(function(mailmap) {
  // Use mailmap
});

Returns
Mailmap

Mailmap.fromBuffer AsyncExperimental

Mailmap.fromBuffer(buf, len).then(function(mailmap) {
  // Use mailmap
});

Parameters	Type
buf	String	buffer to parse the mailmap from
len	Number	the length of the input buffer

Returns
Mailmap

Mailmap.fromRepository AsyncExperimental

Mailmap.fromRepository(repo).then(function(mailmap) {
  // Use mailmap
});

Parameters	Type
repo	Repository	repository to load mailmap information from

Returns
Mailmap

Mailmap#addEntry AsyncExperimental

mailmap.addEntry(real_name, real_email, replace_name, replace_email).then(function(result) {
  // Use result
});

| Parameters | Type | | --- | --- | --- | | real_name | String | the real name to use, or NULL | | real_email | String | the real email to use, or NULL | | replace_name | String | the name to replace, or NULL | | replace_email | String | the email to replace |

Returns
Number	0 on success, or an error code

Mailmap#resolve AsyncExperimental

mailmap.resolve(name, email).then(function(string) {
  // Use string
});

| Parameters | Type | | --- | --- | --- | | name | String | the name to look up | | email | String | the email to look up |

Returns
String

Mailmap#resolveSignature AsyncExperimental

mailmap.resolveSignature(sig).then(function(signature) {
  // Use signature
});

| Parameters | Type | | --- | --- | --- | | sig | Signature | signature to resolve |

Returns
Signature	new signature