TypeScript API / @laikacms/gitlab / GitlabStorageRepositoryOptions

Interface: GitlabStorageRepositoryOptions

Configuration for a GitlabDataSource.

Extends

• GitlabDataSourceOptions

Properties

apiUrl?

readonly optional apiUrl?: string;

Base API URL. Defaults to https://gitlab.com/api/v4 (override for self-hosted).

Inherited from

GitlabDataSourceOptions.apiUrl

---

auth?

readonly optional auth?: GitlabAuth;

Authentication. Anonymous when omitted (only works for public reads).

Inherited from

GitlabDataSourceOptions.auth

---

branch

readonly branch: string;

Branch to write to. Reads also default to this ref.

Inherited from

GitlabDataSourceOptions.branch

---

commitAuthor?

readonly optional commitAuthor?: object;

Optional author_name/author_email attached to every commit.

email

readonly email: string;

name

readonly name: string;

---

defaultFileExtension

readonly defaultFileExtension: string;

---

determineExtension?

readonly optional determineExtension?: DetermineExtension;

Strategy for picking the on-server extension when creating an object.

---

fetch?

readonly optional fetch?: {
  (input, init?): Promise<Response>;
  (input, init?): Promise<Response>;
};

Custom fetch implementation — useful for tests and non-standard runtimes.

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

Parameter	Type
input	RequestInfo | URL
init?	RequestInit

Returns

Promise<Response>

Call Signature

(input, init?): Promise<Response>;

MDN Reference

Parameters

Parameter	Type
input	string | Request | URL
init?	RequestInit

Returns

Promise<Response>

Inherited from

GitlabDataSourceOptions.fetch

---

ignoreList?

readonly optional ignoreList?: readonly string[];

Glob patterns to omit from directory listings.

---

projectId

readonly projectId: string | number;

Project identifier — either the numeric project ID (e.g. 12345) or the URL-encoded path (group/subgroup/project). The implementation URL-encodes whatever you pass, so either form is accepted as-is.

Inherited from

GitlabDataSourceOptions.projectId

---

serializerRegistry

readonly serializerRegistry: StorageSerializerRegistry;

---

userAgent?

readonly optional userAgent?: string;

User-Agent string.

Inherited from

GitlabDataSourceOptions.userAgent