repository-provider 26.0.1 → 26.1.1

package/README.md

@@ -66,11 +66,13 @@ console.log(await readme.getString());
     *   [equals](#equals)
         *   [Parameters](#parameters-8)
     *   [attributes](#attributes)
+    *   [writableAttributes](#writableattributes)
     *   [attributeMapping](#attributemapping)
 *   [description](#description)
 *   [id](#id)
 *   [uuid](#uuid)
 *   [avatarURL](#avatarurl)
+*   [homePageURL](#homepageurl)
 *   [MessageDestination](#messagedestination)
     *   [Parameters](#parameters-9)
 *   [BaseProvider](#baseprovider)
@@ -93,7 +95,7 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-16)
     *   [projects](#projects)
         *   [Parameters](#parameters-17)
-    *   [projects](#projects-1)
+    *   [milestones](#milestones)
         *   [Parameters](#parameters-18)
     *   [repositories](#repositories)
         *   [Parameters](#parameters-19)
@@ -136,6 +138,7 @@ console.log(await readme.getString());
     *   [Parameters](#parameters-28)
     *   [Properties](#properties-5)
     *   [url](#url-1)
+    *   [refType](#reftype)
     *   [isDefault](#isdefault)
     *   [delete](#delete)
     *   [commit](#commit-2)
@@ -178,6 +181,7 @@ console.log(await readme.getString());
     *   [equals](#equals-3)
         *   [Parameters](#parameters-45)
     *   [displayName](#displayname)
+    *   [update](#update)
     *   [toJSON](#tojson-2)
 *   [Project](#project)
     *   [Parameters](#parameters-46)
@@ -209,6 +213,8 @@ console.log(await readme.getString());
 *   [locked](#locked)
 *   [merged](#merged)
 *   [draft](#draft)
+*   [ContentEntry](#contententry)
+    *   [Properties](#properties-9)
 *   [Ref](#ref)
     *   [Parameters](#parameters-52)
     *   [equals](#equals-5)
@@ -229,7 +235,7 @@ console.log(await readme.getString());
     *   [fullCondensedName](#fullcondensedname)
     *   [identifier](#identifier-1)
     *   [issuesURL](#issuesurl)
-    *   [homePageURL](#homepageurl)
+    *   [homePageURL](#homepageurl-1)
     *   [isLocked](#islocked)
     *   [isArchived](#isarchived)
     *   [isDisabled](#isdisabled)
@@ -239,7 +245,7 @@ console.log(await readme.getString());
 *   [isProtected](#isprotected-1)
 *   [RepositoryGroup](#repositorygroup-1)
     *   [Parameters](#parameters-58)
-    *   [Properties](#properties-9)
+    *   [Properties](#properties-10)
     *   [repositoryClass](#repositoryclass-1)
     *   [branchClass](#branchclass-1)
     *   [contentClass](#contentclass)
@@ -252,7 +258,7 @@ console.log(await readme.getString());
     *   [Parameters](#parameters-59)
 *   [Repository](#repository-2)
     *   [Parameters](#parameters-60)
-    *   [Properties](#properties-10)
+    *   [Properties](#properties-11)
     *   [fullName](#fullname-2)
     *   [slug](#slug)
     *   [provider](#provider-3)
@@ -269,13 +275,12 @@ console.log(await readme.getString());
     *   [url](#url-4)
     *   [cloneURL](#cloneurl)
     *   [issuesURL](#issuesurl-1)
-    *   [homePageURL](#homepageurl-1)
+    *   [homePageURL](#homepageurl-2)
     *   [condensedName](#condensedname)
     *   [isArchived](#isarchived-1)
     *   [isLocked](#islocked-1)
     *   [isDisabled](#isdisabled-1)
     *   [isTemplate](#istemplate)
-    *   [update](#update)
     *   [branch](#branch-1)
         *   [Parameters](#parameters-65)
     *   [defaultBranch](#defaultbranch)
@@ -320,7 +325,6 @@ console.log(await readme.getString());
     *   [attributes](#attributes-2)
 *   [defaultBranchName](#defaultbranchname)
 *   [urls](#urls-1)
-*   [homePageURL](#homepageurl-2)
 *   [issuesURL](#issuesurl-2)
 *   [Review](#review)
 *   [SingleGroupProvider](#singlegroupprovider)
@@ -332,6 +336,7 @@ console.log(await readme.getString());
         *   [Parameters](#parameters-82)
 *   [Tag](#tag-1)
     *   [Parameters](#parameters-83)
+    *   [refType](#reftype-1)
     *   [isWritable](#iswritable-1)
 *   [asArray](#asarray)
     *   [Parameters](#parameters-84)
@@ -361,6 +366,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 *   `type` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `writable` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 *   `private` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
+*   `description` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
 ## definePropertiesFromOptions
 
@@ -423,7 +429,7 @@ In other words only produce key value pairs if value is defined.
 
 *   `object` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 *   `initial` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**  (optional, default `{}`)
-*   `skip` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** keys not to put in the result (optional, default `[]`)
+*   `attributes` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** to operator on (optional, default `object.constructor.attributes`)
 
 Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** initial + defined values
 
@@ -460,7 +466,7 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 ### Parameters
 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `additionalProperties`  
+*   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ### equals
 
@@ -474,7 +480,11 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 ### attributes
 
-options
+Attributes definitions
+
+### writableAttributes
+
+Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** writable attributes
 
 ### attributeMapping
 
@@ -506,6 +516,12 @@ Avatar.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+## homePageURL
+
+The url of home page.
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ## MessageDestination
 
 Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
@@ -550,7 +566,7 @@ Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Gl
 
 ### normalizeRepositoryName
 
-Bring a repository name into its normal form by removing any clutter
+Bring a repository name into its normal form by removing any clutter.
 like .git suffix or #branch names.
 
 #### Parameters
@@ -562,7 +578,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### normalizeGroupName
 
-Bring a group name into its normal form by removing any clutter
+Bring a group name into its normal form by removing any clutter.
 like .git suffix or #branch names.
 
 #### Parameters
@@ -574,7 +590,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### areRepositoryNamesCaseSensitive
 
-Are repositroy names case sensitive.
+Are repository names case sensitive.
 Overwrite and return false if you want to have case insensitive repository lookup
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true
@@ -625,9 +641,9 @@ List projects.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator\<Projects>** all matching projects of the provider
+Returns **AsyncIterator<[Project](#project)>** all matching projects of the provider
 
-### projects
+### milestones
 
 List milestones.
 
@@ -635,7 +651,7 @@ List milestones.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[Milestone](#milestone)>** all matching milestones of the provider
+Returns **AsyncIterator<[Milestone](#milestone)>** all matching milestones of the provider
 
 ### repositories
 
@@ -645,7 +661,7 @@ List repositories.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[Repository](#repository)>** all matching repos of the provider
+Returns **AsyncIterator<[Repository](#repository)>** all matching repos of the provider
 
 ### branches
 
@@ -655,7 +671,7 @@ List branches.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[Branch](#branch)>** all matching branches of the provider
+Returns **AsyncIterator<[Branch](#branch)>** all matching branches of the provider
 
 ### tags
 
@@ -665,7 +681,7 @@ List tags.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[Tag](#tag)>** all matching tags of the provider
+Returns **AsyncIterator<[Tag](#tag)>** all matching tags of the provider
 
 ### hooks
 
@@ -675,7 +691,7 @@ List hooks.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[Hook](#hook)>** all matching hooks of the provider
+Returns **AsyncIterator<[Hook](#hook)>** all matching hooks of the provider
 
 ### pullRequests
 
@@ -685,7 +701,7 @@ List pull requests.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
+Returns **AsyncIterator<[PullRequest](#pullrequest)>** all matching pullRequests of the provider
 
 ### repositoryGroupClass
 
@@ -705,7 +721,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 We are our own provider.
 
-Returns **Provider** this
+Returns **[BaseProvider](#baseprovider)** this
 
 ### url
 
@@ -769,7 +785,7 @@ Creates a new provider for a given set of options.
     *   `options.instanceIdentifier` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)?** 
 *   `env` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** taken from process.env
 
-Returns **Provider** newly created provider or undefined if options are not sufficient to construct a provider
+Returns **[BaseProvider](#baseprovider)** newly created provider or undefined if options are not sufficient to construct a provider
 
 ## priority
 
@@ -791,7 +807,7 @@ Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Globa
 ### Properties
 
 *   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** 
+*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** 
 
 ## Commit
 
@@ -839,6 +855,10 @@ Deliver repository and branch url combined.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 'repoUrl#branch'
 
+### refType
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
+
 ### isDefault
 
 Are we the default branch.
@@ -851,7 +871,7 @@ Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 Delete the branch from the [Repository](#repository).
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** 
 
 ### commit
 
@@ -860,10 +880,10 @@ Commit entries.
 #### Parameters
 
 *   `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
-*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)\<ContentEntry>** content to be commited
+*   `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[ContentEntry](#contententry)>** content to be commited
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
-Returns **[CommitResult](#commitresult)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[CommitResult](#commitresult)>** 
 
 ### commitIntoPullRequest
 
@@ -879,7 +899,7 @@ Add commits into a pull request.
     *   `options.skipWithoutCommits` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** do not create a PR if no commits are given
     *   `options.bodyFromCommitMessages` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** generate body from commit messages
 
-Returns **[PullRequest](#pullrequest)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>** 
 
 ### removeEntries
 
@@ -887,7 +907,7 @@ Remove entries form the branch.
 
 #### Parameters
 
-*   `entries` **Iterator\<ContentEntry>** 
+*   `entries` **AsyncIterator<[ContentEntry](#contententry)>** 
 
 ### entryClass
 
@@ -995,7 +1015,7 @@ Lookup a repository in the provider and all of its repository groups.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
 
-Returns **[Repository](#repository)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>** 
 
 ### repositoryGroup
 
@@ -1005,7 +1025,7 @@ Lookup a repository group.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
 
-Returns **[RepositoryGroup](#repositorygroup)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** 
 
 ### repositoryGroups
 
@@ -1015,7 +1035,7 @@ List groups.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
+Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** all matching repositories groups of the provider
 
 ### createRepositoryGroup
 
@@ -1027,7 +1047,7 @@ If there is already a group for the given name it will be returend instead
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
-Returns **[RepositoryGroup](#repositorygroup)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** 
 
 ### addRepositoryGroup
 
@@ -1050,7 +1070,7 @@ Object with a name.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
-*   `additionalProperties`  
+*   `additionalProperties` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
 ### Properties
 
@@ -1072,6 +1092,10 @@ Beatified name use for human displaying only.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** human readable name
 
+### update
+
+Save object attributes in the backing store.
+
 ### toJSON
 
 Provide name and all defined attributes.
@@ -1134,7 +1158,7 @@ Returns **[Repository](#repository)** destination repository
 
 ### provider
 
-Returns **Provider** 
+Returns **[BaseProvider](#baseprovider)** 
 
 ### equals
 
@@ -1168,7 +1192,7 @@ Decline the pull request.
 
 ### reviews
 
-Returns **Interaor<[Review](#review)>** 
+Returns **AsyncIterator<[Review](#review)>** 
 
 ### identifier
 
@@ -1208,7 +1232,7 @@ result will be filtered by source branch, destination branch and states
     *   `filter.destination` **[Branch](#branch)?** 
     *   `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?** 
 
-Returns **Iterator<[PullRequest](#pullrequest)>** 
+Returns **AsyncIterator<[PullRequest](#pullrequest)>** 
 
 ### open
 
@@ -1260,6 +1284,14 @@ Draft state of the pull request.
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** 
 
+## ContentEntry
+
+Type: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)
+
+### Properties
+
+*   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
+
 ## Ref
 
 **Extends NamedObject**
@@ -1278,13 +1310,13 @@ Check for equality.
 
 #### Parameters
 
-*   `other` **[Branch](#branch)** 
+*   `other` **[Ref](#ref)** 
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if name and repository are equal
 
 ### ref
 
-ref name
+ref name.
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** git ref of the Ref
 
@@ -1296,7 +1328,7 @@ Get sha of a ref.
 
 *   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)**  (optional, default `this.ref`)
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** sha of the ref
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
 
 ### entries
 
@@ -1306,13 +1338,13 @@ List entries of the branch.
 
 *   `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
 
-Returns **ContentEntry** all matching entries in the branch
+Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
 
 ### asyncIterator
 
 List all entries of the branch.
 
-Returns **asyncIterator\<ContentEntry>** all entries in the branch
+Returns **AsyncIterator<[ContentEntry](#contententry)>** all entries in the branch
 
 ### maybeEntry
 
@@ -1322,7 +1354,7 @@ Get exactly one matching entry by name or undefine if no such entry is found.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
 
 ### entry
 
@@ -1332,13 +1364,13 @@ Get exactly one matching entry by name (throws if entry is not found).
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<ContentEntry>** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
 
 ### provider
 
 The provider we live in.
 
-Returns **Provider** 
+Returns **[BaseProvider](#baseprovider)** 
 
 ### owner
 
@@ -1422,7 +1454,7 @@ Abstract repository collection.
 
 ### Parameters
 
-*   `provider` **Provider** 
+*   `provider` **[BaseProvider](#baseprovider)** 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the group
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
@@ -1433,7 +1465,7 @@ Abstract repository collection.
 
 ### Properties
 
-*   `provider` **Provider** 
+*   `provider` **[BaseProvider](#baseprovider)** 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
 ### repositoryClass
@@ -1530,7 +1562,7 @@ Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 The owners provider.
 
-Returns **Provider** 
+Returns **[BaseProvider](#baseprovider)** 
 
 ### identifier
 
@@ -1557,7 +1589,7 @@ Lookup entries form the head of the default branch.
 
 *   `name`  
 
-Returns **Entry** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
 
 ### entries
 
@@ -1567,7 +1599,7 @@ List entries of the default branch.
 
 *   `matchingPatterns` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
 
-Returns **Entry** all matching entries in the branch
+Returns **AsyncIterator<[ContentEntry](#contententry)>** all matching entries in the branch
 
 ### maybeEntry
 
@@ -1577,7 +1609,7 @@ Get exactly one matching entry by name or undefined if no such entry is found.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<Entry>** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[ContentEntry](#contententry)>** 
 
 ### urls
 
@@ -1639,10 +1671,6 @@ By default we are not a template.
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
 
-### update
-
-Updates repositroy attributes.
-
 ### branch
 
 Lookup branch by name.
@@ -1665,7 +1693,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `patterns`  
 
-Returns **Iterator<[Branch](#branch)>** of all branches
+Returns **AsyncIterator<[Branch](#branch)>** of all branches
 
 ### createBranch
 
@@ -1699,7 +1727,7 @@ Delete a [Branch](#branch).
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the branch
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** 
 
 ### tags
 
@@ -1707,7 +1735,7 @@ Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/
 
 *   `patterns` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)** 
 
-Returns **Iterator<[Tag](#tag)>** of all tags
+Returns **AsyncIterator<[Tag](#tag)>** of all tags
 
 ### tag
 
@@ -1717,14 +1745,14 @@ Get a Tag.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[Tag](#tag)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Tag](#tag)>** 
 
 ### delete
 
 Delete the repository from the [Provider](Provider).
 [Provider#deleteRepository](Provider#deleteRepository)
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[undefined](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/undefined)>** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** 
 
 ### createPullRequest
 
@@ -1736,7 +1764,7 @@ Create a pull request (or deliver an already present for thefiven name).
 *   `source` **[Branch](#branch)** branch
 *   `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
 
-Returns **[PullRequest](#pullrequest)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[PullRequest](#pullrequest)>** 
 
 ### addPullRequest
 
@@ -1754,7 +1782,7 @@ Returns **[PullRequest](#pullrequest)**
 
 Deliver all [PullRequest](#pullrequest)s.
 
-Returns **Iterator<[PullRequest](#pullrequest)>** of all pull requests
+Returns **AsyncIterator<[PullRequest](#pullrequest)>** of all pull requests
 
 ### pullRequest
 
@@ -1774,7 +1802,7 @@ Delete a [PullRequest](#pullrequest).
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** 
 
 ### addHook
 
@@ -1796,7 +1824,7 @@ Add a new Hook.
 
 List hooks.
 
-Returns **[Hook](#hook)** all hooks of the repository
+Returns **AsyncIterator<[Hook](#hook)>** all hooks of the repository
 
 ### hook
 
@@ -1806,7 +1834,7 @@ Get a Hook.
 
 *   `id` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number))** 
 
-Returns **[Hook](#hook)** for the given id
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Hook](#hook)>** for the given id
 
 ### type
 
@@ -1822,7 +1850,7 @@ Get sha of a ref.
 
 *   `ref` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** sha of the ref
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** sha of the ref
 
 ### repositoryClass
 
@@ -1874,12 +1902,6 @@ URLs of the repository
 
 Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
 
-## homePageURL
-
-The url of home page.
-
-Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
 ## issuesURL
 
 The url of issue tracking system.
@@ -1904,7 +1926,7 @@ Lookup a repository in the provider and all of its repository groups.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** of the repository
 
-Returns **[Repository](#repository)** 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[Repository](#repository)>** 
 
 ### repositoryGroup
 
@@ -1914,7 +1936,7 @@ Get a single group.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
-Returns **[RepositoryGroup](#repositorygroup)** deliver the one and only present group
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[RepositoryGroup](#repositorygroup)>** deliver the one and only present group
 
 ### repositoryGroups
 
@@ -1924,7 +1946,7 @@ List groups.
 
 *   `patterns` **([Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)> | [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String))** 
 
-Returns **Iterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
+Returns **AsyncIterator<[RepositoryGroup](#repositorygroup)>** always deliver the one and only present group
 
 ## Tag
 
@@ -1938,6 +1960,10 @@ Tag refs
 *   `name`  
 *   `options`  
 
+### refType
+
+Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** tags
+
 ### isWritable
 
 Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** false
@@ -1962,7 +1988,7 @@ A URL auth component will be removed to.
 
 *   `name` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 *   `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
-*   `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** to be called with the found base name
+*   `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
 
 Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** name without base
 
@@ -1972,9 +1998,9 @@ Loops over names and executes stripBaseName.
 
 ### Parameters
 
-*   `names` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
+*   `names` **([string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String) | [Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>)** 
 *   `repositoryBases` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** all possible bases
-*   `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)** to be called with the found base name
+*   `whenFound` **[Function](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Statements/function)?** to be called with the found base name
 
 Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** names without base
 
@@ -1989,6 +2015,8 @@ Find a new branch name for a given pattern.
 *   `repository` **[Repository](#repository)** 
 *   `pattern` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
 
+Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** 
+
 # install
 
 With [npm](http://npmjs.org) do: