createPgOpaqueAdvisoryLocks — @gj-kit/toss-payments-postgresql

A public function from @gj-kit/toss-payments-postgresql. The signature below is taken directly from the 0.5.1 release declaration.

Verified import example

import { createPgOpaqueAdvisoryLocks } from '@gj-kit/toss-payments-postgresql';

Signature, parameters, and return type

/**
 * PostgreSQL advisory transaction lock factory.
 *
 * `BEGIN → pg_advisory_xact_lock → callback → COMMIT`은 SqlClient가 보장하는 하나의
 * connection에서 실행된다. callback 또는 lock/commit이 실패하면 best-effort ROLLBACK 후
 * 원래 오류를 그대로 rethrow한다. `pg_advisory_xact_lock`은 commit/rollback과 함께 자동
 * 해제되므로 session-level lock 누수 경로가 없다.
 */
declare function createPgOpaqueAdvisoryLocks(sql: SqlClient, options?: PgOpaqueAdvisoryLocksOptions): PgOpaqueAdvisoryLocks;

This declaration is the source of truth for parameters, optionality, generics, return values, and public union/type contracts. Check the package golden path and this subpath’s import conditions for required environment, permission, and error boundaries before calling it.

Release context

• Package: @gj-kit/toss-payments-postgresql
• Version: 0.5.1
• Public entry: .
• Source: GitHub