UNPKG

5.48 kBMarkdownView Raw
1[![npm](https://img.shields.io/npm/v/gitea-repository-provider.svg)](https://www.npmjs.com/package/gitea-repository-provider)
2[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
3[![minified size](https://badgen.net/bundlephobia/min/gitea-repository-provider)](https://bundlephobia.com/result?p=gitea-repository-provider)
4[![downloads](http://img.shields.io/npm/dm/gitea-repository-provider.svg?style=flat-square)](https://npmjs.org/package/gitea-repository-provider)
5[![Build Status](https://travis-ci.com/arlac77/gitea-repository-provider.svg?branch=master)](https://travis-ci.com/arlac77/gitea-repository-provider)
6[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/arlac77/gitea-repository-provider.git)
7[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
8[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
9[![Known Vulnerabilities](https://snyk.io/test/github/arlac77/gitea-repository-provider/badge.svg)](https://snyk.io/test/github/arlac77/gitea-repository-provider)
10[![codecov.io](http://codecov.io/github/arlac77/gitea-repository-provider/coverage.svg?branch=master)](http://codecov.io/github/arlac77/gitea-repository-provider?branch=master)
11[![Coverage Status](https://coveralls.io/repos/arlac77/gitea-repository-provider/badge.svg)](https://coveralls.io/r/arlac77/gitea-repository-provider)
12
13# gitea-repository-provider
14
15repository provider for gitea
16
17# usage
18
19# API
20
21<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
22
23### Table of Contents
24
25- [GiteaProvider](#giteaprovider)
26 - [headers](#headers)
27 - [repositoryBases](#repositorybases)
28 - [environmentOptions](#environmentoptions)
29 - [areOptionsSufficciant](#areoptionssufficciant)
30 - [Parameters](#parameters)
31- [GiteaBranch](#giteabranch)
32 - [commit](#commit)
33 - [Parameters](#parameters-1)
34- [GiteaContentEntry](#giteacontententry)
35 - [Parameters](#parameters-2)
36- [GiteaMasterOnlyContentEntry](#giteamasteronlycontententry)
37 - [Parameters](#parameters-3)
38- [GiteaPullRequest](#giteapullrequest)
39 - [list](#list)
40 - [Parameters](#parameters-4)
41- [GiteaOrganization](#giteaorganization)
42- [GiteaUser](#giteauser)
43
44## GiteaProvider
45
46**Extends Provider**
47
48Gitea provider
49
50### headers
51
52fetch headers
53
54Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** suitable as fetch headers
55
56### repositoryBases
57
58All possible base urls
59
60Returns **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>** common base urls of all repositories
61
62### environmentOptions
63
64known environment variables
65
66Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
67
68Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** GITEA_TOKEN api token
69
70Returns **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** GITEA_API api url
71
72### areOptionsSufficciant
73
74#### Parameters
75
76- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
77
78Returns **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** true if token an api are present
79
80## GiteaBranch
81
82**Extends Branch**
83
84### commit
85
86Commit entries
87
88#### Parameters
89
90- `message` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** commit message
91- `updates` **[Array](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array)&lt;Entry>** file content to be commited
92- `options` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)**
93
94Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)**
95
96## GiteaContentEntry
97
98**Extends BufferContentEntryMixin(ContentEntry)**
99
100works for all branches
101
102### Parameters
103
104- `branch`
105- `name`
106
107## GiteaMasterOnlyContentEntry
108
109**Extends StreamContentEntryMixin(ContentEntry)**
110
111only works for master branch
112
113### Parameters
114
115- `branch`
116- `name`
117
118## GiteaPullRequest
119
120**Extends PullRequest**
121
122### list
123
124List all pull request for a given repo
125result will be filtered by source branch, destination branch and states
126
127#### Parameters
128
129- `respository` **Repository**
130- `filter` **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** (optional, default `{}`)
131 - `filter.source` **Branch?**
132 - `filter.destination` **Branch?**
133 - `filter.states` **[Set](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Set)&lt;[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)>?**
134
135Returns **Iterator&lt;PullRequest>**
136
137## GiteaOrganization
138
139**Extends RepositoryGroup**
140
141## GiteaUser
142
143**Extends RepositoryGroup**
144
145# install
146
147With [npm](http://npmjs.org) do:
148
149```shell
150npm install gitea-repository-provider
151```
152
153# license
154
155BSD-2-Clause