neo4j-driver/types/session-rx.d.ts

The official Neo4j driver for Javascript

/**
 * Copyright (c) "Neo4j"
 * Neo4j Sweden AB [https://neo4j.com]
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import RxResult from './result-rx'
import RxTransaction from './transaction-rx'
import { TransactionConfig } from 'neo4j-driver-core'
import { Parameters } from './query-runner'
import { Observable } from 'rxjs'

declare type RxTransactionWork<T> = (tx: RxTransaction) => Observable<T>

declare class RxSession {
  run: (
    query: string,
    parameters?: Parameters,
    config?: TransactionConfig
  ) => RxResult

  beginTransaction: (config?: TransactionConfig) => Observable<RxTransaction>

  lastBookmarks: () => string[]
  lastBookmark: () => string[]
  /**
   * @deprecated This method will be removed in version 6.0. Please, use {@link RxSession#executeRead} instead.
   */
  readTransaction: <T>(
    work: RxTransactionWork<T>,
    config?: TransactionConfig
  ) => Observable<T>

  /**
   * @deprecated This method will be removed in version 6.0. Please, use {@link RxSession#executeWrite} instead.
   */
  writeTransaction: <T>(
    work: RxTransactionWork<T>,
    config?: TransactionConfig
  ) => Observable<T>

  executeRead: <T>(
    work: RxTransactionWork<T>,
    config?: TransactionConfig
  ) => Observable<T>

  executeWrite: <T>(
    work: RxTransactionWork<T>,
    config?: TransactionConfig
  ) => Observable<T>

  close: () => Observable<any>
}

export default RxSession