Skip to content

index.md

Latest commit

 

History

History
121 lines (94 loc) · 3.14 KB

index.md

File metadata and controls

121 lines (94 loc) · 3.14 KB
layout default
menu_item api
title Filter
description Version 0.4.0
return_to
API Documentation Index
/api/
sections
listLength listNew unregister #lookup #register MODE OPT Instance Variables
#listLength
#listNew
#unregister
#lookup
#register
#MODE
#OPT
#ivars

Filter.listLength SyncExperimental

var result = Filter.listLength(fl);
Parameters Type
fl FilterList A filter list
Returns
Number The number of filters in the list

Filter.listNew AsyncExperimental

Filter.listNew(repo, mode, options).then(function(filterList) {
  // Use filterList
});
Parameters Type
repo Repository
mode Number
options Number
Returns
FilterList

Filter.unregister SyncExperimental

var result = Filter.unregister(name);
Parameters Type
name String The name under which the filter was registered
Returns
Number 0 on success, error code
<
0 on failure

Filter#lookup SyncExperimental

var filter = filter.lookup(name);

| Parameters | Type | | --- | --- | --- | | name | String | The name of the filter |

Returns
Filter

Filter#register SyncExperimental

var result = filter.register(name, priority);

| Parameters | Type | | --- | --- | --- | | name | String | A name by which the filter can be referenced. Attempting to register with an in-use name will return GIT_EEXISTS. | | priority | Number | The priority for filter application |

Returns
Number 0 on successful registry, error code
<
0 on failure

Filter.MODE ENUM

| Flag | Value | | --- | --- | --- | | Filter.MODE.TO_WORKTREE | 0 | | Filter.MODE.SMUDGE | 0 | | Filter.MODE.TO_ODB | 1 | | Filter.MODE.CLEAN | 1 |

Filter.OPT ENUM

| Flag | Value | | --- | --- | --- | | Filter.OPT.DEFAULT | 0 | | Filter.OPT.ALLOW_UNSAFE | 1 |

Instance Variables

Variable Type
attributes String
version Number