index.md

layout	default
menu_item	api
title	Signature
description	Version 0.19.0
return_to	API Documentation Index /api/
sections	create default fromBuffer now #dup #free #toString Instance Variables #create #default #fromBuffer #now #dup #free #toString #ivars

Signature.create Sync

var signature = Signature.create(name, email, time, offset);

Parameters	Type
name	String	name of the person
email	String	email of the person
time	Number	time when the action happened
offset	Number	timezone offset in minutes for the time

Returns
Signature	new signature, in case of error NULL

Signature.default Sync

var signature = Signature.default(repo);

Parameters	Type
repo	Repository	repository pointer

Returns
Signature	new signature

Signature.fromBuffer Async

Signature.fromBuffer(buf).then(function(signature) {
  // Use signature
});

Parameters	Type
buf	String	signature string

Returns
Signature	new signature

Signature.now Sync

var signature = Signature.now(name, email);

Parameters	Type
name	String	name of the person
email	String	email of the person

Returns
Signature	new signature, in case of error NULL

Signature#dup Async

signature.dup().then(function(signature) {
  // Use signature
});

Returns
Signature	the copy

Signature#free Sync

signature.free();

Signature#toString Sync

var string = signature.toString();

Standard string representation of an author.

Returns
string	Representation of the author.

Instance Variables

Variable	Type	Description
email	String
name	String
when	Time