Options
All
  • Public
  • Public/Protected
  • All
Menu

breeze-client

Index

Namespaces

Classes

Interfaces

Type aliases

Variables

Functions

Object literals

Type aliases

AdapterType

AdapterType: "dataService" | "modelLibrary" | "ajax" | "uriBuilder"

EntityProperty

StructuralObject

StructuralObject: Entity | ComplexObject

StructuralType

StructuralType: EntityType | ComplexType

Variables

Const BYTE_MAX

BYTE_MAX: 255 = 255

Const BYTE_MIN

BYTE_MIN: 0 = 0

Let DELIM

DELIM: string = String.fromCharCode(191)

Const INT16_MAX

INT16_MAX: 32767 = 32767

Const INT16_MIN

INT16_MIN: -32768 = -32768

Const INT32_MAX

INT32_MAX: 2147483647 = 2147483647

Const INT32_MIN

INT32_MIN: -2147483648 = -2147483648

Let RX_COMMA_DELIM1

RX_COMMA_DELIM1: RegExp = /('[^']*'|[^,]+)/g

Let RX_COMMA_DELIM2

RX_COMMA_DELIM2: RegExp = /("[^"]*"|[^,]+)/g

Let RX_IDENTIFIER

RX_IDENTIFIER: RegExp = /^[a-z_][\w.$]*$/i

Let _localTimeRegex

_localTimeRegex: RegExp = /.\d{3}$/

Let arraySlice

arraySlice: (ar: any[], start?: number, end?: number) => any[] = uncurry(Array.prototype.slice)

Type declaration

    • (ar: any[], start?: number, end?: number): any[]
    • Parameters

      • ar: any[]
      • Optional start: number
      • Optional end: number

      Returns any[]

Let camelEdges

camelEdges: RegExp = /([A-Z](?=[A-Z][a-z])|[^A-Z](?=[A-Z])|[a-zA-Z](?=[^a-zA-Z]))/g

Change text to title case with spaces, e.g. 'myPropertyName12' to 'My Property Name 12'

Const config

config: BreezeConfig = new BreezeConfig()

Let hasOwnProperty

hasOwnProperty: (obj: Object, key: string) => boolean = uncurry(Object.prototype.hasOwnProperty)

Type declaration

    • (obj: Object, key: string): boolean
    • Parameters

      • obj: Object
      • key: string

      Returns boolean

Let isES5Supported

isES5Supported: boolean = function () {try {return !!(Object.getPrototypeOf && Object.defineProperty({}, 'x', {}));} catch (e) {return false;}} ()

Let luhn

luhn: (Anonymous function) = (function() {let luhnArr = [0, 2, 4, 6, 8, 1, 3, 5, 7, 9];return function(str: string) {let counter = 0;let incNum: number;let odd = false;let temp = String(str).replace(/[^\d]/g, "");if ( temp.length === 0) return false;for (let i = temp.length - 1; i >= 0; --i) {incNum = parseInt(temp.charAt(i), 10);counter += (odd = !odd) ? incNum : luhnArr[incNum];}return (counter % 10 === 0);};})()

Let proto

proto: Param = Param.prototype

Functions

addContext

  • addContext(that: Param, context: IParamContext): Param

addProperties

  • addProperties(entityType: StructuralType, propObj: Object | undefined, ctor: any): void

addValidators

argsForAndOrPredicates

  • argsForAndOrPredicates(obj: {}, args: any[]): {}[]

arrayAddItemUnique

  • arrayAddItemUnique<T>(array: T[], item: T): void
  • Add item if not already in array

    Type parameters

    • T

    Parameters

    • array: T[]
    • item: T

    Returns void

arrayEquals

  • arrayEquals(a1: any[], a2: any[], equalsFn?: (x1: any, x2: any) => boolean): boolean
  • Parameters

    • a1: any[]
    • a2: any[]
    • Optional equalsFn: (x1: any, x2: any) => boolean
        • (x1: any, x2: any): boolean
        • Parameters

          • x1: any
          • x2: any

          Returns boolean

    Returns boolean

arrayFirst

  • arrayFirst<T>(array: T[], predicate: Predicate<any>): T
  • Return first element matching predicate

    Type parameters

    • T

    Parameters

    Returns T

arrayFlatMap

  • arrayFlatMap<T, U>(arr: T[], mapFn: (arg: T) => U[]): U[]
  • Type parameters

    • T

    • U

    Parameters

    • arr: T[]
    • mapFn: (arg: T) => U[]
        • (arg: T): U[]
        • Parameters

          • arg: T

          Returns U[]

    Returns U[]

arrayIndexOf

  • arrayIndexOf<T>(array: T[], predicate: Predicate<any>): number
  • Return index of first element matching predicate

    Type parameters

    • T

    Parameters

    Returns number

arrayRemoveItem

  • arrayRemoveItem<T>(array: T[], predicateOrItem: T | Predicate<T>, shouldRemoveMultiple?: boolean): boolean
  • Remove items from the array

    Type parameters

    • T

    Parameters

    • array: T[]
    • predicateOrItem: T | Predicate<T>

      item to remove, or function to determine matching item

    • Optional shouldRemoveMultiple: boolean

      true to keep removing after first match, false otherwise

    Returns boolean

arrayZip

  • arrayZip(a1: any[], a2: any[], callback: (x1: any, x2: any) => any): any[]
  • Combine array elements using the callback. Returns array with length == min(a1.length, a2.length)

    Parameters

    • a1: any[]
    • a2: any[]
    • callback: (x1: any, x2: any) => any
        • (x1: any, x2: any): any
        • Parameters

          • x1: any
          • x2: any

          Returns any

    Returns any[]

attachRelatedEntities

buildKeyPredicate

  • buildKeyPredicate(entityKey: EntityKey): AndOrPredicate

buildNavigationPredicate

buildPredicate

  • buildPredicate(entity: Entity): AndOrPredicate

calcUnmappedProperties

checkEntityKey

checkEntityTypes

checkForDups

classof

  • classof(o: any): any

clearAspect

clearOriginalValues

  • clearOriginalValues(target: any): void

clearServerErrors

  • clearServerErrors(entities: Entity[]): void

clone

coEquals

coHasOriginalValues

coerceToBool

  • coerceToBool(source: any, sourceTypeName: string): any

coerceToDate

  • coerceToDate(source: any, sourceTypeName: string): any

coerceToFloat

  • coerceToFloat(source: any, sourceTypeName: string): any

coerceToGuid

  • coerceToGuid(source: any, sourceTypeName: string): any

coerceToInt

  • coerceToInt(source: any, sourceTypeName: string): any

coerceToString

  • coerceToString(source: any, sourceTypeName?: string): any
  • Parameters

    • source: any
    • Optional sourceTypeName: string

    Returns any

combine

  • combine(j1: Object, j2: Object): Object

combineArgs

  • combineArgs(target: Object, source: Object): void

completeParseCsdlEntityType

  • completeParseCsdlEntityType(entityType: EntityType, csdlEntityType: any, schema: any, schemas: any, metadataStore: MetadataStore): void

completeStructuralTypeFromJson

  • completeStructuralTypeFromJson(metadataStore: MetadataStore, json: any, stype: any): void

cpHasOriginalValues

createEmptyCtor

  • createEmptyCtor(type: any): any

createEntityErrors

createEntityKey

createError

createExpr

  • createExpr(source: any, exprContext: ExpressionContext): PredicateExpression
  • Parameters

    • source: any
    • exprContext: ExpressionContext

    Returns PredicateExpression

createPredicateFromArray

  • createPredicateFromArray(arr: any[]): Predicate

createPredicateFromKeyValue

  • createPredicateFromKeyValue(key: string, value: any): Predicate

createPredicateFromObject

  • createPredicateFromObject(obj: Object): Predicate

durationToSeconds

  • durationToSeconds(duration: string): number

exec

  • exec(self: Param): boolean

executeQueryCore

executeQueryLocallyCore

exportEntityGroup

  • exportEntityGroup(entityGroup: EntityGroup, tempKeys: ITempKey[]): { entities: any[] }

exportEntityGroups

exportTempKeyInfo

extend

  • extend(target: Object, source: Object, propNames?: string[]): Object
  • Copy properties from source to target. Returns target.

    Parameters

    • target: Object
    • source: Object
    • Optional propNames: string[]

    Returns Object

extractDeletedKeysDefault

  • extractDeletedKeysDefault(data: any): any

extractKeyMappingsDefault

  • extractKeyMappingsDefault(data: any): any

extractResultsDefault

  • extractResultsDefault(data: any): any

extractSaveResultsDefault

  • extractSaveResultsDefault(data: any): any

fallbackErrorHandler

  • fallbackErrorHandler(e: Error): void

fetchEntityByKeyCore

findOrCreateEntityGroup

findOrCreateEntityGroups

fixupKeys

fmtBinary

  • fmtBinary(val: any): any

fmtBoolean

  • fmtBoolean(val: any): boolean

fmtDateTime

  • fmtDateTime(val: Date): string

fmtDateTimeOffset

  • fmtDateTimeOffset(val: Date): string

fmtGuid

  • fmtGuid(val: any): string

fmtInt

  • fmtInt(val: any): any

fmtString

  • fmtString(val: any): string

fmtTime

  • fmtTime(val: any): string

fmtUndefined

  • fmtUndefined(val: any): any

formatString

  • formatString(str: string, ...params: any[]): string
  • format("a %1 and a %2", "cat", "dog") -> "a cat and a dog"

    Parameters

    • str: string
    • Rest ...params: any[]

    Returns string

formatTemplate

  • formatTemplate(template: string, vars: Object, ownPropertiesOnly?: boolean): string
  • Parameters

    • template: string
    • vars: Object
    • Default value ownPropertiesOnly: boolean = false

    Returns string

fromJSON

getAnyAllPredicateFn

  • getAnyAllPredicateFn(op: Op): (v1: any[], v2: any) => boolean
  • Parameters

    Returns (v1: any[], v2: any) => boolean

      • (v1: any[], v2: any): boolean
      • Parameters

        • v1: any[]
        • v2: any

        Returns boolean

getArray

  • getArray(source: Object, propName: string): any[]
  • Returns an array for a source and a prop, and creates the prop if needed.

    Parameters

    • source: Object
    • propName: string

    Returns any[]

getAssociation

  • getAssociation(csdlNavProperty: any, containingSchema: any, schemas: any[]): IAssociation

getBinaryPredicateFn

getChangesCore

getConcurrencyDateTime

  • getConcurrencyDateTime(val: any): Date

getEntitiesCore

getEntitiesToSave

getEntityGroups

getFilter

  • getFilter(entityStates: EntityState[]): (Anonymous function)

getGoodAdds

getMappedKey

getMessage

  • getMessage(context: IParamContext, v: any): string | ((context: IParamContext, v: any) => string)
  • Parameters

    • context: IParamContext
    • v: any

    Returns string | ((context: IParamContext, v: any) => string)

getNamespaceFor

  • getNamespaceFor(shortName: string, schema: any): any

getNextDateTime

  • getNextDateTime(): Date

getNextGuid

  • getNextGuid(): string

getNextNumber

  • getNextNumber(): number

getNextString

  • getNextString(): string

getOwnPropertyValues

  • getOwnPropertyValues(source: Object): any[]
  • Return an array of property values from source

    Parameters

    • source: Object

    Returns any[]

getPropDescriptor

  • getPropDescriptor(obj: Object, propertyName: string): PropertyDescriptor | undefined
  • Parameters

    • obj: Object
    • propertyName: string

    Returns PropertyDescriptor | undefined

getQualifiedTypeName

  • getQualifiedTypeName(metadataStore: MetadataStore, structTypeName: string, throwIfNotFound?: boolean): any

getRawValueFromConfig

  • getRawValueFromConfig(rawEntity: any, dp: DataProperty): any

getSerializerFn

getTypesFromMap

getUuid

  • getUuid(): string

getValidatorCtor

  • getValidatorCtor(dataType: DataType): (Anonymous function)

handleHttpError

  • handleHttpError(reject: (reason?: any) => void, httpResponse: HttpResponse, messagePrefix?: string): void

hasProperty

  • hasProperty(context: IParamContext, v: any): boolean

identity

  • identity(x: any): any

importEntityGroup

  • importEntityGroup(entityGroup: EntityGroup, jsonGroup: { entities: any[] }, importConfig: ImportConfigExt): Entity[]

initializeParent

  • initializeParent(obsArray: any, parent: Object, parentProperty: DataProperty): void

intRangeValidatorCtor

  • intRangeValidatorCtor(validatorName: string, minValue: number, maxValue: number, context: any): (Anonymous function)
  • Parameters

    • validatorName: string
    • minValue: number
    • maxValue: number
    • context: any

    Returns (Anonymous function)

isArray

  • isArray(context: IParamContext, v: any): boolean

isArrayMessage

  • isArrayMessage(context: IParamContext, v: any): string

isDate

  • isDate(o: any): boolean

isDateString

  • isDateString(s: string): boolean

isDuration

  • isDuration(value: any): boolean

isEdmxEnumType

  • isEdmxEnumType(csdlProperty: any, schema: any): boolean

isEmpty

  • isEmpty(obj: any): boolean

isEntity

  • isEntity(context: any, v: any): boolean

isEntityProperty

  • isEntityProperty(context: any, v: any): any

isEnumOf

  • isEnumOf(context: IParamContext, v: any): any

isEnumType

  • isEnumType(csdlProperty: any, schema: any): any

isFunction

  • isFunction(o: any): boolean

isGuid

  • isGuid(value: any): boolean

isIdentityProperty

  • isIdentityProperty(csdlProperty: any): boolean

isInstanceOf

  • isInstanceOf(context: IParamContext, v: any): boolean

isNonEmptyString

  • isNonEmptyString(context: IParamContext, v: any): boolean

isNumeric

  • isNumeric(n: any): boolean

isODataEnumType

  • isODataEnumType(csdlProperty: any, schema: any): any

isOptional

  • isOptional(context: IParamContext, v: any): boolean

isOptionalMessage

  • isOptionalMessage(context: IParamContext, v: any): string

isQualifiedTypeName

  • isQualifiedTypeName(entityTypeName: string): boolean

isRequired

  • isRequired(context: IParamContext, v: any): boolean

isSettable

  • isSettable(obj: Object, propertyName: string): boolean
  • Parameters

    • obj: Object
    • propertyName: string

    Returns boolean

isTypeOf

  • isTypeOf(context: IParamContext, v: any): boolean

localPropsOnly

makeFloatFmt

  • makeFloatFmt(fmtSuffix: string): (Anonymous function)

makeRegExpValidator

  • makeRegExpValidator(validatorName: string, expression: RegExp, defaultMessage?: string | null, context?: any): Validator
  • Parameters

    • validatorName: string
    • expression: RegExp
    • Optional defaultMessage: string | null
    • Optional context: any

    Returns Validator

map

  • map<T>(items: T | T[], fn: (v: T, ix?: number) => any, includeNull?: boolean): any | any[]
  • a version of Array.map that doesn't require an array, i.e. works on arrays and scalars.

    Type parameters

    • T

    Parameters

    • items: T | T[]
    • fn: (v: T, ix?: number) => any
        • (v: T, ix?: number): any
        • Parameters

          • v: T
          • Optional ix: number

          Returns any

    • Optional includeNull: boolean

    Returns any | any[]

markIsBeingSaved

  • markIsBeingSaved(entities: Entity[], flag: boolean): void

markLoadedNavPath

  • markLoadedNavPath(entities: Entity[], propNames: string[]): void

markLoadedNavProps

memoize

  • memoize(fn: any): any
  • Remember & return the value of fn() when it was called with its current args

    Parameters

    • fn: any

    Returns any

mergeEntity

mergeProps

mergeRelatedEntities

  • mergeRelatedEntities(mc: MappingContext, navigationProperty: NavigationProperty, targetEntity: Entity, rawEntity: any): void

mergeRelatedEntitiesCore

  • mergeRelatedEntitiesCore(mc: MappingContext, rawEntity: any, navigationProperty: NavigationProperty): any

mergeRelatedEntity

  • mergeRelatedEntity(mc: MappingContext, navigationProperty: NavigationProperty, targetEntity: Entity, rawEntity: any): void

mergeRelatedEntityCore

  • mergeRelatedEntityCore(mc: MappingContext, rawEntity: any, navigationProperty: NavigationProperty): any

mergeStructuralType

noop

  • noop(): void

normalizePropertyPaths

  • normalizePropertyPaths(propertyPaths: string | string[]): string[]

objectFirst

  • objectFirst(obj: Object, kvPredicate: (key: string, val: any) => boolean): { key: string; value: any } | null
  • Parameters

    • obj: Object
    • kvPredicate: (key: string, val: any) => boolean
        • (key: string, val: any): boolean
        • Parameters

          • key: string
          • val: any

          Returns boolean

    Returns { key: string; value: any } | null

objectForEach

  • objectForEach(obj: Object, kvFn: (key: string, val: any) => any): void
  • Parameters

    • obj: Object
    • kvFn: (key: string, val: any) => any
        • (key: string, val: any): any
        • Parameters

          • key: string
          • val: any

          Returns any

    Returns void

objectMap

  • objectMap(obj: Object, kvFn?: (key: string, val: any) => any): any[]
  • Parameters

    • obj: Object
    • Optional kvFn: (key: string, val: any) => any
        • (key: string, val: any): any
        • Parameters

          • key: string
          • val: any

          Returns any

    Returns any[]

parse

parseCsdlComplexProperty

parseCsdlComplexType

parseCsdlDataProperty

parseCsdlEntityType

parseCsdlNavProperty

parseCsdlSimpleProperty

parseExpr

  • parseExpr(source: string, tokens: string[], exprContext: ExpressionContext): PredicateExpression
  • Parameters

    • source: string
    • tokens: string[]
    • exprContext: ExpressionContext

    Returns PredicateExpression

parseFnExpr

  • parseFnExpr(source: string, parts: string[], tokens: string[], exprContext: ExpressionContext): FnExpr
  • Parameters

    • source: string
    • parts: string[]
    • tokens: string[]
    • exprContext: ExpressionContext

    Returns FnExpr

parseLitOrPropExpr

  • parseLitOrPropExpr(value: string, exprContext: ExpressionContext): PredicateExpression
  • Parameters

    • value: string
    • exprContext: ExpressionContext

    Returns PredicateExpression

parseRawBinary

  • parseRawBinary(val: any): any

parseRawDate

  • parseRawDate(val: any): any

parseTypeNameWithSchema

  • parseTypeNameWithSchema(entityTypeName: string, schema: any): { namespace: string; shortTypeName: string; typeName: string }
  • Parameters

    • entityTypeName: string
    • schema: any

    Returns { namespace: string; shortTypeName: string; typeName: string }

    • namespace: string
    • shortTypeName: string
    • typeName: string

pluck

  • pluck(propertyName: any): (obj: Object) => any
  • can be used like persons.map(pluck("firstName"))

    Parameters

    • propertyName: any

    Returns (obj: Object) => any

      • (obj: Object): any
      • Parameters

        • obj: Object

        Returns any

postChangeEvents

  • postChangeEvents(context: IContext): void

processAdds

  • processAdds(obsArray: ObservableArray, adds: any[]): void

processAnonType

  • processAnonType(mc: MappingContext, node: any): {}

processMeta

  • processMeta(mc: MappingContext, node: any, meta: NodeMeta, assignFn?: (val: any) => void): any
  • Parameters

    • mc: MappingContext
    • node: any
    • meta: NodeMeta
    • Optional assignFn: (val: any) => void
        • (val: any): void
        • Parameters

          • val: any

          Returns void

    Returns any

processNoMerge

  • processNoMerge(mc: MappingContext, stype: StructuralType, node: any): {}

processRemoves

  • processRemoves(obsArray: ObservableArray, removes: any[]): void

processServerErrors

  • processServerErrors(saveContext: SaveContext, saveError: SaveErrorFromServer): SaveError

processUsing

  • processUsing(eq: EntityQuery, map: Object, value: any, propertyName?: string): void

promiseWithCallbacks

  • promiseWithCallbacks<T>(promise: Promise<T>, callback?: Callback, errorCallback?: ErrorCallback): Promise<T>

propEq

  • propEq(propertyName: string, value: any): (obj: Object) => boolean
  • can be used like: persons.filter(propEq("firstName", "John"))

    Parameters

    • propertyName: string
    • value: any

    Returns (obj: Object) => boolean

      • (obj: Object): boolean
      • Parameters

        • obj: Object

        Returns boolean

propsEq

  • propsEq(property1Name: string, property2Name: string, value: any): (obj: Object) => boolean
  • can be used like: persons.filter(propEq("firstName", "FirstName", "John"))

    Parameters

    • property1Name: string
    • property2Name: string
    • value: any

    Returns (obj: Object) => boolean

      • (obj: Object): boolean
      • Parameters

        • obj: Object

        Returns boolean

publish

  • publish(publisher: ObservableArray, eventName: string, eventArgs: any): void

publishCore

  • publishCore<T>(that: BreezeEvent<T>, data: T, errorCallback?: (e: Error) => any): boolean

qualifyTypeName

  • qualifyTypeName(shortName: string, ns?: string): string

rejectChangesCore

  • rejectChangesCore(target: any): void

removeFromRelations

removeFromRelationsCore

  • removeFromRelationsCore(entity: Entity): void

requireLib

  • requireLib(libNames: string, errMessage?: string): any
  • Calls requireLibCore on semicolon-separated libNames

    Parameters

    • libNames: string
    • Optional errMessage: string

    Returns any

requireLibCore

  • requireLibCore(libName: string): any
  • Returns the 'libName' module if loaded or else returns undefined

    Parameters

    • libName: string

    Returns any

resolveCp

resolveDataType

resolveEntityRef

  • resolveEntityRef(mc: MappingContext, nodeRefId: string): any

resolveProperties

  • resolveProperties(sources: Object[], propertyNames: string[]): any
  • Resolves the values of a list of properties by checking each property in multiple sources until a value is found.

    Parameters

    • sources: Object[]
    • propertyNames: string[]

    Returns any

resolveRelated

setAsDefault

  • setAsDefault(target: Object, ctor: { constructor: any; defaultInstance?: any }): any
  • Set ctor.defaultInstance to an instance of ctor with properties from target. We want to insure that the object returned by ctor.defaultInstance is always immutable Use 'target' as the primary template for the ctor.defaultInstance; Use current 'ctor.defaultInstance' as the template for any missing properties creates a new instance for ctor.defaultInstance returns target unchanged

    Parameters

    • target: Object
    • ctor: { constructor: any; defaultInstance?: any }
      • constructor: function
        • new __type(...args: any[]): any
      • Optional defaultInstance?: any

    Returns any

setAspect

setContext

  • setContext(that: Param, context: IParamContext): Param

setDpValueComplex

  • setDpValueComplex(context: IContext, rawAccessorFn: Function): void

setDpValueSimple

  • setDpValueSimple(context: IContext, rawAccessorFn: any): void

setNpValue

  • setNpValue(context: IContext, rawAccessorFn: Function): void

stringContains

stringEndsWith

  • stringEndsWith(str: string, suffix: string): boolean
  • Parameters

    • str: string
    • suffix: string

    Returns boolean

stringEquals

stringStartsWith

  • stringStartsWith(str: string, prefix: string): boolean
  • Parameters

    • str: string
    • prefix: string

    Returns boolean

structuralObjectToJson

structuralTypeFromJson

throwConfigError

  • throwConfigError(instance: any, message: string): void

throwError

  • throwError(msg: string, val: any): void

throwSetInverseError

titleCaseSpace

  • titleCaseSpace(text: string): string

toArray

  • toArray(item: any): any[]

toJSONSafe

  • toJSONSafe(obj: any, replacer?: (prop: string, value: any) => any): any
  • Safely perform toJSON logic on objects with cycles.

    Parameters

    • obj: any
    • Optional replacer: (prop: string, value: any) => any
        • (prop: string, value: any): any
        • Parameters

          • prop: string
          • value: any

          Returns any

    Returns any

toJSONSafeReplacer

  • toJSONSafeReplacer(prop: string, val: any): any
  • Replacer function for toJSONSafe, when serializing entities. Excludes entityAspect and other internal properties.

    Parameters

    • prop: string
    • val: any

    Returns any

toJson

  • toJson(source: Object, template: Object, target?: Object): Object
  • 'source' is an object that will be transformed into another 'template' is a map where the keys: are the keys to return if a key contains ','s then the key is treated as a delimited string with first of the keys being the key to return and the others all valid aliases for this key 'values' are either

    1. the 'default' value of the key
    2. a function that takes in the source value and should return the value to set The value from the source is then set on the target, after first passing thru the fn, if provided, UNLESS:
    3. it is the default value
    4. it is undefined ( nulls WILL be set) 'target' is optional
    • if it exists then properties of the target will be set ( overwritten if the exist)
    • if it does not exist then a new object will be created as filled. 'target is returned.

    Parameters

    • source: Object
    • template: Object
    • Default value target: Object = {}

    Returns Object

tryResolveNp

uncurry

  • uncurry(f: any): (Anonymous function)
  • Parameters

    • f: any

    Returns (Anonymous function)

unwrapChangedValues

unwrapInstance

unwrapOriginalValues

updateAliasMap

  • updateAliasMap(aliasMap: OpMap, opStr: string, op: Op): void

updateClientServerNames

  • updateClientServerNames(nc: NamingConvention, parent: any, clientPropName: string): void

updateConcurrencyProperties

  • updateConcurrencyProperties(entities: Entity[]): void

updateConcurrencyProperty

updateEntity

  • updateEntity(mc: MappingContext, targetEntity: Entity, node: any): void

updateEntityNoMerge

  • updateEntityNoMerge(mc: MappingContext, targetEntity: Entity, node: any): void

updateEntityRef

  • updateEntityRef(mc: MappingContext, targetEntity: any, node: any): void

updateEntityState

  • updateEntityState(obsArray: ObservableArray): void

updateRelatedEntity

updateRelatedEntityInCollection

  • updateRelatedEntityInCollection(mc: MappingContext, relatedEntity: Entity | undefined, relatedEntities: Entity[], targetEntity: Entity, inverseProperty: NavigationProperty): void

updateStateAndValidate

  • updateStateAndValidate(context: IContext): void

updateWithConfig

updateWithDefaults

  • updateWithDefaults(target: Object, defaults: Object): any
  • Copy properties from defaults iff undefined on target. Returns target.

    Parameters

    • target: Object
    • defaults: Object

    Returns any

using

  • using(obj: Object, property: string, tempValue: any, fn: () => any): any
  • Execute fn while obj has tempValue for property

    Parameters

    • obj: Object
    • property: string
    • tempValue: any
    • fn: () => any
        • (): any
        • Returns any

    Returns any

validate

validateEntityStates

validateTarget

  • validateTarget(target: any, coIndex?: number): boolean

visitNode

  • visitNode(node: any, mc: MappingContext, nodeContext: NodeContext, result: Object, key: string): any

wrapExecution

  • wrapExecution(startFn: () => any, endFn: (state: any) => any, fn: () => any): any
  • Call state = startFn(), call fn(), call endFn(state)

    Parameters

    • startFn: () => any
        • (): any
        • Returns any

    • endFn: (state: any) => any
        • (state: any): any
        • Parameters

          • state: any

          Returns any

    • fn: () => any
        • (): any
        • Returns any

    Returns any

Object literals

Const breeze

breeze: object

AbstractDataServiceAdapter

AbstractDataServiceAdapter: AbstractDataServiceAdapter = AbstractDataServiceAdapter

AutoGeneratedKeyType

AutoGeneratedKeyType: AutoGeneratedKeyType = AutoGeneratedKeyType

BooleanQueryOp

BooleanQueryOp: BooleanQueryOp = BooleanQueryOp

ComplexAspect

ComplexAspect: ComplexAspect = ComplexAspect

ComplexType

ComplexType: ComplexType = ComplexType

DataProperty

DataProperty: DataProperty = DataProperty

DataService

DataService: DataService = DataService

DataType

DataType: DataType = DataType

EntityAction

EntityAction: EntityAction = EntityAction

EntityAspect

EntityAspect: EntityAspect = EntityAspect

EntityKey

EntityKey: EntityKey = EntityKey

EntityManager

EntityManager: EntityManager = EntityManager

EntityQuery

EntityQuery: EntityQuery = EntityQuery

EntityState

EntityState: EntityState = EntityState

EntityType

EntityType: EntityType = EntityType

Event

Event: BreezeEvent = BreezeEvent

FetchStrategy

FetchStrategy: FetchStrategy = FetchStrategy

FilterQueryOp

FilterQueryOp: FilterQueryOp = FilterQueryOp

InterfaceRegistry

InterfaceRegistry: InterfaceRegistry = InterfaceRegistry

JsonResultsAdapter

JsonResultsAdapter: JsonResultsAdapter = JsonResultsAdapter

KeyGenerator

KeyGenerator: KeyGenerator = KeyGenerator

LocalQueryComparisonOptions

LocalQueryComparisonOptions: LocalQueryComparisonOptions = LocalQueryComparisonOptions

MergeStrategy

MergeStrategy: MergeStrategy = MergeStrategy

MetadataStore

MetadataStore: MetadataStore = MetadataStore

NamingConvention

NamingConvention: NamingConvention = NamingConvention

NavigationProperty

NavigationProperty: NavigationProperty = NavigationProperty

OrderByClause

OrderByClause: OrderByClause = OrderByClause

Param

Param: Param

Predicate

Predicate: Predicate = Predicate

QueryOptions

QueryOptions: QueryOptions = QueryOptions

SaveOptions

SaveOptions: SaveOptions = SaveOptions

ValidationError

ValidationError: ValidationError = ValidationError

ValidationOptions

ValidationOptions: ValidationOptions = ValidationOptions

Validator

Validator: Validator

assertConfig

assertConfig: any = null as any

assertParam

assertParam: any = null as any

config

config: BreezeConfig = config

core

core: { arrayAddItemUnique: arrayAddItemUnique; arrayEquals: arrayEquals; arrayFirst: arrayFirst; arrayFlatMap: arrayFlatMap; arrayIndexOf: arrayIndexOf; arrayRemoveItem: arrayRemoveItem; arraySlice: (ar: any[], start?: number, end?: number) => any[]; arrayZip: arrayZip; durationToSeconds: durationToSeconds; extend: extend; formatString: formatString; getArray: getArray; getOwnPropertyValues: getOwnPropertyValues; getPropertyDescriptor: getPropDescriptor; getUuid: getUuid; hasOwnProperty: (obj: Object, key: string) => boolean; identity: identity; isDate: isDate; isDateString: isDateString; isDuration: isDuration; isES5Supported: boolean; isEmpty: isEmpty; isFunction: isFunction; isGuid: isGuid; isNumeric: isNumeric; isSettable: isSettable; map: map; memoize: memoize; noop: noop; objectFirst: objectFirst; objectForEach: objectForEach; objectMap: objectMap; pluck: pluck; propEq: propEq; propsEq: propsEq; requireLib: requireLib; resolveProperties: resolveProperties; setAsDefault: setAsDefault; stringEndsWith: stringEndsWith; stringStartsWith: stringStartsWith; titleCase: titleCaseSpace; toArray: toArray; toJSONSafe: toJSONSafe; toJSONSafeReplacer: toJSONSafeReplacer; toJson: toJson; updateWithDefaults: updateWithDefaults; using: using; wrapExecution: wrapExecution } = core

Type declaration

makeComplexArray

makeComplexArray: makeComplexArray = makeComplexArray

makePrimitiveArray

makePrimitiveArray: makePrimitiveArray = makePrimitiveArray

makeRelationArray

makeRelationArray: makeRelationArray = makeRelationArray

version

version: string = "2.0.10"

Let complexArrayMixin

complexArrayMixin: object

_acceptChanges

  • _acceptChanges(): void

_beforeChange

  • _beforeChange(): void

_getGoodAdds

  • An Event that fires whenever the contents of this array changed. This event is fired any time a new entity is attached or added to the EntityManager and happens to belong to this collection. Adds that occur as a result of query or import operations are batched so that all of the adds or removes to any individual collections are collected into a single notification event for each relation array.

    example

    // assume order is an order entity attached to an EntityManager. orders.arrayChanged.subscribe( function (arrayChangedArgs) { var addedEntities = arrayChangedArgs.added; var removedEntities = arrayChanged.removed; });

    readonly

    Parameters

    • adds: any[]

    Returns ComplexObject[]

_processAdds

  • _processAdds(adds: any[]): void

_processRemoves

  • _processRemoves(removes: any[]): void

_rejectChanges

  • _rejectChanges(): void

Const core

core: object

arrayAddItemUnique

arrayAddItemUnique: arrayAddItemUnique = arrayAddItemUnique

arrayEquals

arrayEquals: arrayEquals = arrayEquals

arrayFirst

arrayFirst: arrayFirst = arrayFirst

arrayFlatMap

arrayFlatMap: arrayFlatMap = arrayFlatMap

arrayIndexOf

arrayIndexOf: arrayIndexOf = arrayIndexOf

arrayRemoveItem

arrayRemoveItem: arrayRemoveItem = arrayRemoveItem

arraySlice

arraySlice: (ar: any[], start?: number, end?: number) => any[] = arraySlice

Type declaration

    • (ar: any[], start?: number, end?: number): any[]
    • Parameters

      • ar: any[]
      • Optional start: number
      • Optional end: number

      Returns any[]

arrayZip

arrayZip: arrayZip = arrayZip

durationToSeconds

durationToSeconds: durationToSeconds = durationToSeconds

extend

extend: extend = extend

formatString

formatString: formatString = formatString

getArray

getArray: getArray = getArray

getOwnPropertyValues

getOwnPropertyValues: getOwnPropertyValues = getOwnPropertyValues

getPropertyDescriptor

getPropertyDescriptor: getPropDescriptor = getPropDescriptor

getUuid

getUuid: getUuid = getUuid

hasOwnProperty

hasOwnProperty: (obj: Object, key: string) => boolean = hasOwnProperty

Type declaration

    • (obj: Object, key: string): boolean
    • Parameters

      • obj: Object
      • key: string

      Returns boolean

identity

identity: identity = identity

isDate

isDate: isDate = isDate

isDateString

isDateString: isDateString = isDateString

isDuration

isDuration: isDuration = isDuration

isES5Supported

isES5Supported: boolean = isES5Supported

isEmpty

isEmpty: isEmpty = isEmpty

isFunction

isFunction: isFunction = isFunction

isGuid

isGuid: isGuid = isGuid

isNumeric

isNumeric: isNumeric = isNumeric

isSettable

isSettable: isSettable = isSettable

map

map: map = map

memoize

memoize: memoize = memoize

noop

noop: noop = noop

objectFirst

objectFirst: objectFirst = objectFirst

objectForEach

objectForEach: objectForEach = objectForEach

objectMap

objectMap: objectMap = objectMap

pluck

pluck: pluck = pluck

propEq

propEq: propEq = propEq

propsEq

propsEq: propsEq = propsEq

requireLib

requireLib: requireLib = requireLib

resolveProperties

resolveProperties: resolveProperties = resolveProperties

setAsDefault

setAsDefault: setAsDefault = setAsDefault

stringEndsWith

stringEndsWith: stringEndsWith = stringEndsWith

stringStartsWith

stringStartsWith: stringStartsWith = stringStartsWith

titleCase

titleCase: titleCaseSpace = titleCaseSpace

toArray

toArray: toArray = toArray

toJSONSafe

toJSONSafe: toJSONSafe = toJSONSafe

toJSONSafeReplacer

toJSONSafeReplacer: toJSONSafeReplacer = toJSONSafeReplacer

toJson

toJson: toJson = toJson

updateWithDefaults

updateWithDefaults: updateWithDefaults = updateWithDefaults

using

using: using = using

wrapExecution

wrapExecution: wrapExecution = wrapExecution

Let mixin

mixin: object

_beforeChange

  • _beforeChange(): void

_getEventParent

  • _getEventParent(): any

_getPendingPubs

  • _getPendingPubs(): any

_push

  • _push(...args: any[]): any

getEntityAspect

  • getEntityAspect(): any

pop

  • pop(): any

push

  • push(...args: any[]): any

shift

  • shift(): any

splice

  • splice(...args: any[]): any

unshift

  • unshift(...args: any[]): any

Let primitiveArrayMixin

primitiveArrayMixin: object

_acceptChanges

  • _acceptChanges(): void

_beforeChange

  • _beforeChange(): void

_getGoodAdds

  • _getGoodAdds(adds: any[]): any[]
  • An Event that fires whenever the contents of this array changed. This event is fired any time a new entity is attached or added to the EntityManager and happens to belong to this collection. Adds that occur as a result of query or import operations are batched so that all of the adds or removes to any individual collections are collected into a single notification event for each relation array.

    example

    // assume order is an order entity attached to an EntityManager. orders.arrayChanged.subscribe( function (arrayChangedArgs) { let addedEntities = arrayChangedArgs.added; let removedEntities = arrayChanged.removed; });

    readonly

    Parameters

    • adds: any[]

    Returns any[]

_processAdds

  • _processAdds(adds: any[]): void

_processRemoves

  • _processRemoves(removes: any[]): void

_rejectChanges

  • _rejectChanges(): void

Let relationArrayMixin

relationArrayMixin: object

_getEventParent

  • _getEventParent(): any

_getGoodAdds

_getPendingPubs

  • _getPendingPubs(): any

_processAdds

  • _processAdds(adds: Entity[]): void

_processRemoves

  • _processRemoves(removes: Entity[]): void

load

  • Performs an asynchronous load of all other the entities associated with this relationArray.

    example

    // assume orders is an empty, as yet unpopulated, relation array of orders // associated with a specific customer. orders.load().then(...)

    method

    load

    Parameters

    Returns Promise<QueryResult>

Let rootContext

rootContext: object

displayName

Let toFunctionVisitor

toFunctionVisitor: object

isExtended

isExtended: boolean = false

andOrPredicate

  • andOrPredicate(this: AndOrPredicate, context: VisitContext): (Anonymous function)
  • Parameters

    • this: AndOrPredicate
    • context: VisitContext

    Returns (Anonymous function)

anyAllPredicate

  • anyAllPredicate(this: AnyAllPredicate, context: VisitContext): (Anonymous function)
  • Parameters

    • this: AnyAllPredicate
    • context: VisitContext

    Returns (Anonymous function)

binaryPredicate

  • binaryPredicate(this: BinaryPredicate, context: VisitContext): (Anonymous function)
  • Parameters

    • this: BinaryPredicate
    • context: VisitContext

    Returns (Anonymous function)

fnExpr

  • fnExpr(this: FnExpr, context: ExpressionContext): (Anonymous function)
  • Parameters

    • this: FnExpr
    • context: ExpressionContext

    Returns (Anonymous function)

litExpr

  • litExpr(this: LitExpr): (Anonymous function)

passthruPredicate

  • passthruPredicate(this: PassthruPredicate): never

propExpr

  • propExpr(this: PropExpr): (Anonymous function)

unaryPredicate

  • unaryPredicate(this: UnaryPredicate, context: VisitContext): (Anonymous function)
  • Parameters

    • this: UnaryPredicate
    • context: VisitContext

    Returns (Anonymous function)

Let toJSONVisitor

toJSONVisitor: object

andOrPredicate

  • andOrPredicate(this: AndOrPredicate, context: VisitContext): Object

anyAllPredicate

  • anyAllPredicate(this: AnyAllPredicate, context: VisitContext): {}

binaryPredicate

  • binaryPredicate(this: BinaryPredicate, context: VisitContext): {}

fnExpr

  • fnExpr(this: FnExpr, context: VisitContext): string

litExpr

  • litExpr(this: LitExpr, context: VisitContext): any

passthruPredicate

  • passthruPredicate(this: PassthruPredicate): any

propExpr

  • propExpr(this: PropExpr, context: VisitContext): string

unaryPredicate

  • unaryPredicate(this: UnaryPredicate, context: VisitContext): {}

Generated using TypeDoc