Class BucketNodeBuilder

A builder for BucketNodeInterfaces

Hierarchy

AbstractNodeBuilder<BucketNodeInterface, BucketNodeBuilder>
- BucketNodeBuilder

Implements

BuilderInterface<BucketNodeInterface>

Index

Constructors

constructor

Properties

_node

Methods

Constructors

constructor

new BucketNodeBuilder(): BucketNodeBuilder

Overrides AbstractNodeBuilder.constructor
- Defined in lib/builders/BucketNodeBuilder.ts:8
Returns BucketNodeBuilder

Properties

Protected _node

_node: BucketNodeInterface

Methods

build

build(): BucketNodeInterface

Implementation of BuilderInterface.build

Inherited from AbstractNodeBuilder.build
- Defined in lib/builders/AbstractNodeBuilder.ts:36
Returns BucketNodeInterface

Protected getThis

getThis(): BucketNodeBuilder

Overrides AbstractNodeBuilder.getThis
- Defined in lib/builders/BucketNodeBuilder.ts:34
Returns BucketNodeBuilder

withChild

withChild(node: BucketNodeInterface): BucketNodeBuilder

Inherited from AbstractNodeBuilder.withChild
- Defined in lib/builders/AbstractNodeBuilder.ts:31
Parameters
- node: BucketNodeInterface
Returns BucketNodeBuilder

withMaxDepth

withMaxDepth(maxDepth: number): BucketNodeBuilder

- Defined in lib/builders/BucketNodeBuilder.ts:29
Set the maxDepth of the BucketNodeInterface

Parameters
- maxDepth: number
  
  max depth
Returns BucketNodeBuilder

withName

withName(name: string): BucketNodeBuilder

Implementation of BuilderInterface.withName

Inherited from AbstractNodeBuilder.withName
- Defined in lib/builders/AbstractNodeBuilder.ts:16
Parameters
- name: string
Returns BucketNodeBuilder

withPattern

withPattern(pattern: string | RegExp): BucketNodeBuilder

- Defined in lib/builders/BucketNodeBuilder.ts:19
Set the pattern of the BucketNodeInterface

Parameters
- pattern: string | RegExp
  
  the pattern
Returns BucketNodeBuilder

withReadContent

withReadContent(reader: function): BucketNodeBuilder

Inherited from AbstractNodeBuilder.withReadContent
- Defined in lib/builders/AbstractNodeBuilder.ts:21
Parameters
- reader: function
  - - (): Bluebird<any>
    - Returns Bluebird<any>
Returns BucketNodeBuilder

withWriteContent

withWriteContent(writer: function): BucketNodeBuilder

Inherited from AbstractNodeBuilder.withWriteContent
- Defined in lib/builders/AbstractNodeBuilder.ts:26
Parameters
- writer: function
  - - (content: any): Bluebird<void>
    - Parameters
      - content: any
      Returns Bluebird<void>
Returns BucketNodeBuilder

Generated using TypeDoc