Skip to content

TypeScript API / @laikacms/gitlab / GitlabDataSourceOptions

Interface: GitlabDataSourceOptions ​

Configuration for a GitlabDataSource.

Extended by ​

Properties ​

apiUrl? ​

ts
readonly optional apiUrl?: string;

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


auth? ​

ts
readonly optional auth?: GitlabAuth;

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


branch ​

ts
readonly branch: string;

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


fetch? ​

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

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

Call Signature ​

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

MDN Reference

Parameters ​
ParameterType
inputRequestInfo | URL
init?RequestInit
Returns ​

Promise<Response>

Call Signature ​

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

MDN Reference

Parameters ​
ParameterType
inputstring | Request | URL
init?RequestInit
Returns ​

Promise<Response>


projectId ​

ts
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.


userAgent? ​

ts
readonly optional userAgent?: string;

User-Agent string.

Released under the MIT License.