@pvm/gitlab

Classes

• GitlabPlatform

Interfaces

• AlterReleaseResult
• CreateReleasePayload
• EditReleasePayload
• GitlabTagRelease
• GitlabTagResult
• Group
• MergeRequest
• MergeRequestApprovals
• Milestone
• MrNote
• Person
• Pipeline
• ProjectApprovals
• PublicMember
• PublicPerson
• QueryArgs
• SyncAttachmentOpts
• UploadResult

Type aliases

UriSlug

Ƭ UriSlug: string | number

Defined in

packages/pvm-gitlab/lib/api/api-helpers.ts:2

Functions

addTagAndRelease

▸ addTagAndRelease(projectId, ref, data): Promise<AlterReleaseResult>

Parameters

Name	Type
projectId	string | number
ref	string
data	CreateReleasePayload

Returns

Promise<AlterReleaseResult>

Defined in

packages/pvm-gitlab/lib/api/releases/by-tags/alter.ts:5

---

create

▸ create(projectId, data): Promise<AlterReleaseResult>

Parameters

Name	Type
projectId	any
data	any

Returns

Promise<AlterReleaseResult>

Defined in

packages/pvm-gitlab/lib/api/releases/by-releases/alter.ts:6

---

createRelease

▸ createRelease(projectId, data): Promise<AlterReleaseResult>

Parameters

Name	Type
projectId	string | number
data	EditReleasePayload

Returns

Promise<AlterReleaseResult>

Defined in

packages/pvm-gitlab/lib/api/releases/by-tags/alter.ts:32

---

default

▸ default(projectId, label): Promise<HttpResponseSuccess<any>>

Parameters

Name	Type
projectId	any
label	any

Returns

Promise<HttpResponseSuccess<any>>

Defined in

packages/pvm-gitlab/lib/api/labels/create.ts:5

---

encodeSlug

▸ encodeSlug(uriSlug): string

Parameters

Name	Type
uriSlug	UriSlug

Returns

string

Defined in

packages/pvm-gitlab/lib/api/api-helpers.ts:4

---

findMergedLastMr

▸ findMergedLastMr(branchName?): Promise<MergeRequest>

Parameters

Name	Type
branchName	undefined | string

Returns

Promise<MergeRequest>

Defined in

packages/pvm-gitlab/lib/hal/merge-request.ts:19

---

findNote

▸ findNote(iid, kind): Promise<MetaComment<MrNote> | void>

Parameters

Name	Type
iid	number
kind	string

Returns

Promise<MetaComment<MrNote> | void>

Defined in

packages/pvm-gitlab/lib/hal/mark-pr.ts:16

---

findOpenSingleMr

▸ findOpenSingleMr(branchName?): Promise<MergeRequest>

Parameters

Name	Type
branchName	undefined | string

Returns

Promise<MergeRequest>

Defined in

packages/pvm-gitlab/lib/hal/merge-request.ts:5

---

getApiUrl

▸ getApiUrl(config): string

Parameters

Name	Type
config	Config

Returns

string

Defined in

packages/pvm-gitlab/lib/remote-url.ts:5

---

getGitlabHostUrl

▸ getGitlabHostUrl(config): string

Parameters

Name	Type
config	Config

Returns

string

Defined in

packages/pvm-gitlab/lib/remote-url.ts:12

---

getMaintainers

▸ getMaintainers(projectId?): AsyncIterableIterator<PublicMember>

Parameters

Name	Type	Default value
projectId	UriSlug	gitalbEnv.projectId

Returns

AsyncIterableIterator<PublicMember>

Defined in

packages/pvm-gitlab/lib/hal/members.ts:24

---

getProjectMembers

▸ getProjectMembers(projectId?): AsyncIterableIterator<PublicMember>

Parameters

Name	Type	Default value
projectId	UriSlug	gitalbEnv.projectId

Returns

AsyncIterableIterator<PublicMember>

Defined in

packages/pvm-gitlab/lib/hal/members.ts:6

---

glapi

▸ glapi<T>(uri, opts?): Promise<HttpResponseSuccess<T>>

Type parameters

Name	Type
T	any

Parameters

Name	Type
uri	string
opts	HttpReqOptions

Returns

Promise<HttpResponseSuccess<T>>

Defined in

packages/pvm-gitlab/lib/api/index.ts:14

---

httpPagesGen

▸ httpPagesGen<T>(href, queryArgs?, fetchOpts?): AsyncIterableIterator<HttpResponseSuccess<T[]>>

Type parameters

Name	Type
T	any

Parameters

Name	Type
href	string
queryArgs	QueryArgs
fetchOpts	HttpReqOptions

Returns

AsyncIterableIterator<HttpResponseSuccess<T[]>>

Defined in

packages/pvm-gitlab/lib/api/pages-gen.ts:14

---

mergeRequestApprovals

▸ mergeRequestApprovals(projectId, mrIid): Promise<MergeRequestApprovals>

Parameters

Name	Type
projectId	UriSlug
mrIid	number

Returns

Promise<MergeRequestApprovals>

Defined in

packages/pvm-gitlab/lib/api/mr/approvals.ts:47

---

ownersWithoutDogs

▸ ownersWithoutDogs(owners): string[]

Parameters

Name	Type
owners	string[]

Returns

string[]

Defined in

packages/pvm-gitlab/lib/api/mr/approvals.ts:101

---

pagesGen

▸ pagesGen<T>(url, queryArgs?, fetchOpts?): AsyncIterableIterator<T>

Type parameters

Name	Type
T	any

Parameters

Name	Type
url	any
queryArgs	QueryArgs
fetchOpts	HttpReqOptions

Returns

AsyncIterableIterator<T>

Defined in

packages/pvm-gitlab/lib/api/pages-gen.ts:39

---

projectApprovals

▸ projectApprovals(projectId): Promise<ProjectApprovals>

Parameters

Name	Type
projectId	UriSlug

Returns

Promise<ProjectApprovals>

Defined in

packages/pvm-gitlab/lib/api/mr/approvals.ts:26

---

projectPagesGen

▸ projectPagesGen<T>(projectId, url, queryArgs?, fetchOpts?): AsyncIterableIterator<T>

Type parameters

Name	Type
T	any

Parameters

Name	Type
projectId	UriSlug
url	string
queryArgs	QueryArgs
fetchOpts	HttpReqOptions

Returns

AsyncIterableIterator<T>

Defined in

packages/pvm-gitlab/lib/api/pages-gen.ts:55

---

releaseTags

▸ releaseTags(projectId, fetchOpts?): AsyncGenerator<any, void, unknown>

Parameters

Name	Type
projectId	any
fetchOpts	HttpReqOptions

Returns

AsyncGenerator<any, void, unknown>

Defined in

packages/pvm-gitlab/lib/api/tags/tags.ts:11

---

setApprovalsRequired

▸ setApprovalsRequired(projectId, iid, count): Promise<HttpResponseSuccess<MergeRequestApprovals>>

Parameters

Name	Type
projectId	UriSlug
iid	number
count	number

Returns

Promise<HttpResponseSuccess<MergeRequestApprovals>>

Defined in

packages/pvm-gitlab/lib/api/mr/approvals.ts:54

---

setApprovers

▸ setApprovers(projectId, iid, approvers): Promise<HttpResponseSuccess>

Parameters

Name	Type
projectId	UriSlug
iid	number
approvers	string[]

Returns

Promise<HttpResponseSuccess>

Defined in

packages/pvm-gitlab/lib/api/mr/approvals.ts:64

---

syncAttachment

▸ syncAttachment(iid, kind, attachment, opts?): Promise<HttpResponseSuccess>

Parameters

Name	Type
iid	number
kind	string
attachment	Buffer
opts	SyncAttachmentOpts

Returns

Promise<HttpResponseSuccess>

Defined in

packages/pvm-gitlab/lib/hal/mark-pr.ts:66

---

syncText

▸ syncText(iid, kind, text): Promise<HttpResponseSuccess>

Parameters

Name	Type
iid	number
kind	string
text	string

Returns

Promise<HttpResponseSuccess>

Defined in

packages/pvm-gitlab/lib/hal/mark-pr.ts:40

---

update

▸ update(projectId, data): Promise<AlterReleaseResult>

Parameters

Name	Type
projectId	any
data	any

Returns

Promise<AlterReleaseResult>

Defined in

packages/pvm-gitlab/lib/api/releases/by-releases/alter.ts:18

---

updateRelease

▸ updateRelease(projectId, data): Promise<AlterReleaseResult>

Parameters

Name	Type
projectId	string | number
data	EditReleasePayload

Returns

Promise<AlterReleaseResult>

Defined in

packages/pvm-gitlab/lib/api/releases/by-tags/alter.ts:65

---

uploadFile

▸ uploadFile(projectId, data, filename): Promise<UploadResult>

Parameters

Name	Type
projectId	string | number
data	Buffer
filename	string

Returns

Promise<UploadResult>

Defined in

packages/pvm-gitlab/lib/api/upload.ts:41

---

upsertRelease

▸ upsertRelease(projectId, data): Promise<AlterReleaseResult>

Parameters

Name	Type
projectId	string | number
data	EditReleasePayload

Returns

Promise<AlterReleaseResult>

Defined in

packages/pvm-gitlab/lib/api/releases/by-tags/alter.ts:47