Bitbucket Data Center API Client
    Preparing search index...

    Interface RefMatcher

    Matches a set of refs (branches/tags) by exact id, pattern, or branching-model category. Used by default reviewer conditions, branch restrictions, and default tasks.

    // Match a specific branch
    { id: 'refs/heads/main', type: { id: 'BRANCH' } }

    // Match any ref
    { id: 'ANY_REF_MATCHER_ID', type: { id: 'ANY_REF' } }

    // Match by pattern
    { id: 'release/**', type: { id: 'PATTERN' } }
    interface RefMatcher {
        displayId?: string;
        id: string;
        type: { id: RefMatcherTypeId; name?: string };
    }
    Index

    Properties

    displayId? id type

    Properties

    displayId?: string

    Human-readable form of id (e.g. 'main'); returned by the server

    id: string

    The ref, pattern, or category being matched (e.g. 'refs/heads/main')

    type: { id: RefMatcherTypeId; name?: string }

    Type Declaration

    • id: RefMatcherTypeId
    • Optionalname?: string

      Human-readable matcher type name (e.g. 'Branch'); returned by the server, not needed on write

    Settings

    Member Visibility

    On This Page

    Properties