index.md

layout

default

menu_item

api

title

ConfigIterator

description

Version 0.26.1

return_to

API Documentation Index
/api/

sections

create	createGlob	createMultivar	#next
#create	#createGlob	#createMultivar	#next

ConfigIterator.create AsyncExperimental

ConfigIterator.create(cfg).then(function(configIterator) {
  // Use configIterator
});

Parameters	Type
cfg	Config	where to ge the variables from

Returns
ConfigIterator

ConfigIterator.createGlob(cfg, regexp).then(function(configIterator) {
  // Use configIterator
});

Parameters	Type
cfg	Config	where to ge the variables from
regexp	String	regular expression to match the names

Returns
ConfigIterator

ConfigIterator.createMultivar(cfg, name, regexp).then(function(configIterator) {
  // Use configIterator
});

Parameters	Type
cfg	Config	where to look for the variable
name	String	the variable's name
regexp	String	regular expression to filter which variables we're interested in. Use NULL to indicate all

Returns
ConfigIterator

var result = configIterator.next(entry);

| Parameters | Type | | --- | --- | --- | | entry | ConfigEntry | pointer to store the entry |

Returns
Number	0 or an error code. GIT_ITEROVER if the iteration has completed