@bentley/bentleyjs-core
Advanced tools
Comparing version 0.187.0 to 0.189.0
@@ -5,2 +5,35 @@ { | ||
{ | ||
"version": "0.189.0", | ||
"tag": "@bentley/bentleyjs-core_v0.189.0", | ||
"date": "Wed, 06 Mar 2019 15:41:22 GMT", | ||
"comments": { | ||
"none": [ | ||
{ | ||
"comment": "Changes package.json to include api-extractor and adds api-extractor.json" | ||
}, | ||
{ | ||
"comment": "Use new buildIModelJsBuild script" | ||
}, | ||
{ | ||
"comment": "Add release tags to indicate API stability" | ||
}, | ||
{ | ||
"comment": "Remove uneeded typedoc plugin depedency" | ||
}, | ||
{ | ||
"comment": "Save BUILD_SEMVER to globally accessible map" | ||
}, | ||
{ | ||
"comment": "upgrade to TypeScript 3.2.2" | ||
} | ||
] | ||
} | ||
}, | ||
{ | ||
"version": "0.188.0", | ||
"tag": "@bentley/bentleyjs-core_v0.188.0", | ||
"date": "Wed, 16 Jan 2019 16:36:09 GMT", | ||
"comments": {} | ||
}, | ||
{ | ||
"version": "0.187.0", | ||
@@ -7,0 +40,0 @@ "tag": "@bentley/bentleyjs-core_v0.187.0", |
# Change Log - @bentley/bentleyjs-core | ||
This log was last generated on Tue, 15 Jan 2019 15:18:59 GMT and should not be manually modified. | ||
This log was last generated on Wed, 06 Mar 2019 15:41:22 GMT and should not be manually modified. | ||
## 0.189.0 | ||
Wed, 06 Mar 2019 15:41:22 GMT | ||
### Updates | ||
- Changes package.json to include api-extractor and adds api-extractor.json | ||
- Use new buildIModelJsBuild script | ||
- Add release tags to indicate API stability | ||
- Remove uneeded typedoc plugin depedency | ||
- Save BUILD_SEMVER to globally accessible map | ||
- upgrade to TypeScript 3.2.2 | ||
## 0.188.0 | ||
Wed, 16 Jan 2019 16:36:09 GMT | ||
*Version update only* | ||
## 0.187.0 | ||
@@ -6,0 +23,0 @@ Tue, 15 Jan 2019 15:18:59 GMT |
@@ -5,2 +5,3 @@ /** @module Logging */ | ||
* See [ActivityLoggingContext rules]($docs/learning/backend/managingactivityloggingcontext.md). | ||
* @beta ActivityLoggingContext is scheduled to be renamed before the 1.0 release. | ||
*/ | ||
@@ -7,0 +8,0 @@ export declare class ActivityLoggingContext { |
@@ -11,2 +11,3 @@ "use strict"; | ||
* See [ActivityLoggingContext rules]($docs/learning/backend/managingactivityloggingcontext.md). | ||
* @beta ActivityLoggingContext is scheduled to be renamed before the 1.0 release. | ||
*/ | ||
@@ -13,0 +14,0 @@ class ActivityLoggingContext { |
@@ -9,4 +9,5 @@ /** @module Utils */ | ||
* which indicate a misuse of the API which should be eliminated during development. | ||
* @beta Need strategy for removing assert in production builds | ||
*/ | ||
export declare function assert(condition: boolean, msg?: string): void; | ||
//# sourceMappingURL=Assert.d.ts.map |
@@ -16,2 +16,3 @@ "use strict"; | ||
* which indicate a misuse of the API which should be eliminated during development. | ||
* @beta Need strategy for removing assert in production builds | ||
*/ | ||
@@ -18,0 +19,0 @@ function assert(condition, msg) { |
/** @module Events */ | ||
/** A function invoked when a BeEvent is raised. */ | ||
/** A function invoked when a BeEvent is raised. | ||
* @public | ||
*/ | ||
export declare type Listener = (...arg: any[]) => void; | ||
@@ -8,2 +10,3 @@ /** | ||
* exposed as a property for others to *subscribe* via [[BeEvent.addListener]]. | ||
* @public | ||
*/ | ||
@@ -44,3 +47,3 @@ export declare class BeEvent<T extends Listener> { | ||
*/ | ||
raiseEvent(..._args: any[]): void; | ||
raiseEvent(...args: any[]): void; | ||
/** Determine whether this BeEvent has a specified listener registered. | ||
@@ -54,3 +57,5 @@ * @param listener The listener to check. | ||
} | ||
/** Specialization of BeEvent for Ui events that take a single strongly typed argument. */ | ||
/** Specialization of BeEvent for Ui events that take a single strongly typed argument. | ||
* @beta Right name? Right package? | ||
*/ | ||
export declare class BeUiEvent<TEventArgs> extends BeEvent<(args: TEventArgs) => void> { | ||
@@ -63,2 +68,3 @@ /** Raises event with single strongly typed argument. */ | ||
* This class may be used instead of explicitly declaring each BeEvent as a member of a containing class. | ||
* @beta Is this class used? | ||
*/ | ||
@@ -65,0 +71,0 @@ export declare class BeEventList<T extends Listener> { |
@@ -19,2 +19,3 @@ "use strict"; | ||
* exposed as a property for others to *subscribe* via [[BeEvent.addListener]]. | ||
* @public | ||
*/ | ||
@@ -80,3 +81,3 @@ class BeEvent { | ||
*/ | ||
raiseEvent(..._args) { | ||
raiseEvent(...args) { | ||
this._insideRaiseEvent = true; | ||
@@ -92,3 +93,3 @@ const listeners = this._listeners; | ||
else { | ||
context.listener.apply(context.scope, arguments); | ||
context.listener.apply(context.scope, args); | ||
if (context.once) { | ||
@@ -122,3 +123,5 @@ context.listener = undefined; | ||
exports.BeEvent = BeEvent; | ||
/** Specialization of BeEvent for Ui events that take a single strongly typed argument. */ | ||
/** Specialization of BeEvent for Ui events that take a single strongly typed argument. | ||
* @beta Right name? Right package? | ||
*/ | ||
class BeUiEvent extends BeEvent { | ||
@@ -132,2 +135,3 @@ /** Raises event with single strongly typed argument. */ | ||
* This class may be used instead of explicitly declaring each BeEvent as a member of a containing class. | ||
* @beta Is this class used? | ||
*/ | ||
@@ -134,0 +138,0 @@ class BeEventList { |
@@ -8,2 +8,3 @@ /** @module Errors */ | ||
* If a status code is to be returned, prefer to return a more specific error status type such as IModelStatus or DbResult. | ||
* @public | ||
*/ | ||
@@ -16,2 +17,3 @@ export declare const enum BentleyStatus { | ||
* Error status codes are divided into separate ranges for different kinds of errors. All known ranges at least should be defined here, to avoid collisions. | ||
* @public | ||
*/ | ||
@@ -88,3 +90,5 @@ export declare const enum IModelStatus { | ||
} | ||
/** Error status from various briefcase operations */ | ||
/** Error status from various briefcase operations | ||
* @beta Should these be internal? | ||
*/ | ||
export declare const enum BriefcaseStatus { | ||
@@ -99,3 +103,5 @@ CannotAcquire = 131072, | ||
} | ||
/** RpcInterface status codes */ | ||
/** RpcInterface status codes | ||
* @beta Should these be internal? | ||
*/ | ||
export declare enum RpcInterfaceStatus { | ||
@@ -107,3 +113,5 @@ Success = 0, | ||
} | ||
/** Error status from various ChangeSet operations */ | ||
/** Error status from various ChangeSet operations | ||
* @beta Should these be internal? | ||
*/ | ||
export declare const enum ChangeSetStatus { | ||
@@ -163,3 +171,5 @@ Success = 0, | ||
} | ||
/** Return codes for methods which perform repository management operations */ | ||
/** Return codes for methods which perform repository management operations | ||
* @beta Should these be internal? | ||
*/ | ||
export declare const enum RepositoryStatus { | ||
@@ -196,3 +206,5 @@ Success = 0, | ||
} | ||
/** Status from returned HTTP status code */ | ||
/** Status from returned HTTP status code | ||
* @beta Should these be internal? | ||
*/ | ||
export declare const enum HttpStatus { | ||
@@ -210,3 +222,5 @@ /** 2xx Success */ | ||
} | ||
/** Server returned WSG errors */ | ||
/** Server returned WSG errors | ||
* @beta Right name? Right package? | ||
*/ | ||
export declare const enum WSStatus { | ||
@@ -231,2 +245,5 @@ Success = 0, | ||
} | ||
/** iModelHub Services Errors | ||
* @beta Right package? | ||
*/ | ||
export declare enum IModelHubStatus { | ||
@@ -287,2 +304,5 @@ Success = 0, | ||
} | ||
/** Authentication Errors | ||
* @beta Internal? Right package? | ||
*/ | ||
export declare enum AuthStatus { | ||
@@ -293,3 +313,5 @@ Success = 0, | ||
} | ||
/** When you want to associate an explanatory message with an error status value. */ | ||
/** When you want to associate an explanatory message with an error status value. | ||
* @beta Internal? | ||
*/ | ||
export interface StatusCodeWithMessage<ErrorCodeType> { | ||
@@ -301,5 +323,8 @@ status: ErrorCodeType; | ||
* Declared as a function so that the expense of creating the meta-data is only paid when it is needed. | ||
* @public | ||
*/ | ||
export declare type GetMetaDataFunction = () => any; | ||
/** The error type thrown by this module. `BentleyError` subclasses `Error` to add an `errorNumber` member. See [[IModelStatus]] for `errorNumber` values. */ | ||
/** The error type thrown by this module. `BentleyError` subclasses `Error` to add an `errorNumber` member. See [[IModelStatus]] for `errorNumber` values. | ||
* @public | ||
*/ | ||
export declare class BentleyError extends Error { | ||
@@ -306,0 +331,0 @@ private readonly _getMetaData; |
@@ -13,2 +13,3 @@ "use strict"; | ||
* If a status code is to be returned, prefer to return a more specific error status type such as IModelStatus or DbResult. | ||
* @public | ||
*/ | ||
@@ -22,2 +23,3 @@ var BentleyStatus; | ||
* Error status codes are divided into separate ranges for different kinds of errors. All known ranges at least should be defined here, to avoid collisions. | ||
* @public | ||
*/ | ||
@@ -95,3 +97,5 @@ var IModelStatus; | ||
})(IModelStatus = exports.IModelStatus || (exports.IModelStatus = {})); | ||
/** Error status from various briefcase operations */ | ||
/** Error status from various briefcase operations | ||
* @beta Should these be internal? | ||
*/ | ||
var BriefcaseStatus; | ||
@@ -107,3 +111,5 @@ (function (BriefcaseStatus) { | ||
})(BriefcaseStatus = exports.BriefcaseStatus || (exports.BriefcaseStatus = {})); | ||
/** RpcInterface status codes */ | ||
/** RpcInterface status codes | ||
* @beta Should these be internal? | ||
*/ | ||
var RpcInterfaceStatus; | ||
@@ -116,3 +122,5 @@ (function (RpcInterfaceStatus) { | ||
})(RpcInterfaceStatus = exports.RpcInterfaceStatus || (exports.RpcInterfaceStatus = {})); | ||
/** Error status from various ChangeSet operations */ | ||
/** Error status from various ChangeSet operations | ||
* @beta Should these be internal? | ||
*/ | ||
var ChangeSetStatus; | ||
@@ -173,3 +181,5 @@ (function (ChangeSetStatus) { | ||
})(ChangeSetStatus = exports.ChangeSetStatus || (exports.ChangeSetStatus = {})); | ||
/** Return codes for methods which perform repository management operations */ | ||
/** Return codes for methods which perform repository management operations | ||
* @beta Should these be internal? | ||
*/ | ||
var RepositoryStatus; | ||
@@ -207,3 +217,5 @@ (function (RepositoryStatus) { | ||
})(RepositoryStatus = exports.RepositoryStatus || (exports.RepositoryStatus = {})); | ||
/** Status from returned HTTP status code */ | ||
/** Status from returned HTTP status code | ||
* @beta Should these be internal? | ||
*/ | ||
var HttpStatus; | ||
@@ -222,3 +234,5 @@ (function (HttpStatus) { | ||
})(HttpStatus = exports.HttpStatus || (exports.HttpStatus = {})); | ||
/** Server returned WSG errors */ | ||
/** Server returned WSG errors | ||
* @beta Right name? Right package? | ||
*/ | ||
var WSStatus; | ||
@@ -244,3 +258,5 @@ (function (WSStatus) { | ||
})(WSStatus = exports.WSStatus || (exports.WSStatus = {})); | ||
// iModelHub Services Errors | ||
/** iModelHub Services Errors | ||
* @beta Right package? | ||
*/ | ||
var IModelHubStatus; | ||
@@ -303,3 +319,5 @@ (function (IModelHubStatus) { | ||
})(IModelHubStatus = exports.IModelHubStatus || (exports.IModelHubStatus = {})); | ||
// Authentication Errors | ||
/** Authentication Errors | ||
* @beta Internal? Right package? | ||
*/ | ||
var AuthStatus; | ||
@@ -311,3 +329,5 @@ (function (AuthStatus) { | ||
})(AuthStatus = exports.AuthStatus || (exports.AuthStatus = {})); | ||
/** The error type thrown by this module. `BentleyError` subclasses `Error` to add an `errorNumber` member. See [[IModelStatus]] for `errorNumber` values. */ | ||
/** The error type thrown by this module. `BentleyError` subclasses `Error` to add an `errorNumber` member. See [[IModelStatus]] for `errorNumber` values. | ||
* @public | ||
*/ | ||
class BentleyError extends Error { | ||
@@ -314,0 +334,0 @@ constructor(errorNumber, message, log, category, getMetaData) { |
@@ -27,2 +27,7 @@ "use strict"; | ||
__export(require("./PriorityQueue")); | ||
if ((typeof (BUILD_SEMVER) !== "undefined") && (typeof window !== "undefined") && window) { | ||
if (!window.iModelJsVersions) | ||
window.iModelJsVersions = new Map(); | ||
window.iModelJsVersions.set("bentleyjs-core", BUILD_SEMVER); | ||
} | ||
/** @module Utils */ | ||
@@ -29,0 +34,0 @@ /** @docs-package-description |
/** @module BeSQLite */ | ||
/** Whether to open a database readonly or writeable. */ | ||
/** Whether to open a database readonly or writeable. | ||
* @public | ||
*/ | ||
export declare const enum OpenMode { | ||
@@ -7,3 +9,5 @@ Readonly = 1, | ||
} | ||
/** Values, stored in changesets, that indicate what operation was performed on the database. */ | ||
/** Values, stored in changesets, that indicate what operation was performed on the database. | ||
* @public | ||
*/ | ||
export declare const enum DbOpcode { | ||
@@ -17,3 +21,5 @@ /** A row was deleted. */ | ||
} | ||
/** Values for return codes from BeSQLite functions. Consult SQLite documentation for further explanations. */ | ||
/** Values for return codes from BeSQLite functions. Consult SQLite documentation for further explanations. | ||
* @public | ||
*/ | ||
export declare const enum DbResult { | ||
@@ -163,4 +169,4 @@ /** Success */ | ||
} | ||
/** | ||
* Options that specify how to apply ChangeSets. | ||
/** Options that specify how to apply ChangeSets. | ||
* @public | ||
*/ | ||
@@ -167,0 +173,0 @@ export declare enum ChangeSetApplyOption { |
@@ -8,3 +8,5 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
/** Whether to open a database readonly or writeable. */ | ||
/** Whether to open a database readonly or writeable. | ||
* @public | ||
*/ | ||
var OpenMode; | ||
@@ -15,3 +17,5 @@ (function (OpenMode) { | ||
})(OpenMode = exports.OpenMode || (exports.OpenMode = {})); | ||
/** Values, stored in changesets, that indicate what operation was performed on the database. */ | ||
/** Values, stored in changesets, that indicate what operation was performed on the database. | ||
* @public | ||
*/ | ||
var DbOpcode; | ||
@@ -26,3 +30,5 @@ (function (DbOpcode) { | ||
})(DbOpcode = exports.DbOpcode || (exports.DbOpcode = {})); | ||
/** Values for return codes from BeSQLite functions. Consult SQLite documentation for further explanations. */ | ||
/** Values for return codes from BeSQLite functions. Consult SQLite documentation for further explanations. | ||
* @public | ||
*/ | ||
var DbResult; | ||
@@ -173,4 +179,4 @@ (function (DbResult) { | ||
})(DbResult = exports.DbResult || (exports.DbResult = {})); | ||
/** | ||
* Options that specify how to apply ChangeSets. | ||
/** Options that specify how to apply ChangeSets. | ||
* @public | ||
*/ | ||
@@ -177,0 +183,0 @@ var ChangeSetApplyOption; |
@@ -20,2 +20,3 @@ /** @module Utils */ | ||
* @see PriorityQueue | ||
* @public | ||
*/ | ||
@@ -25,15 +26,15 @@ export declare type OrderedComparator<T, U = T> = (lhs: T, rhs: U) => number; | ||
* An [[OrderedComparator]] for numbers that treats two numbers as equal if the absolute value of their difference is less than a specified tolerance. | ||
* @hidden | ||
* @public | ||
*/ | ||
export declare function compareWithTolerance(a: number, b: number, tolerance?: number): number; | ||
/** @hidden */ | ||
/** @public */ | ||
export declare function compareNumbers(a: number, b: number): number; | ||
/** @hidden */ | ||
/** @public */ | ||
export declare function compareBooleans(a: boolean, b: boolean): number; | ||
/** @hidden */ | ||
/** @public */ | ||
export declare function compareStrings(a: string, b: string): number; | ||
/** @hidden */ | ||
/** @public */ | ||
export declare function comparePossiblyUndefined<T>(compareDefined: (lhs: T, rhs: T) => number, lhs?: T, rhs?: T): number; | ||
/** @hidden */ | ||
/** @public */ | ||
export declare function compareStringsOrUndefined(lhs?: string, rhs?: string): number; | ||
//# sourceMappingURL=Compare.d.ts.map |
@@ -10,3 +10,3 @@ "use strict"; | ||
* An [[OrderedComparator]] for numbers that treats two numbers as equal if the absolute value of their difference is less than a specified tolerance. | ||
* @hidden | ||
* @public | ||
*/ | ||
@@ -22,12 +22,12 @@ function compareWithTolerance(a, b, tolerance = 0.1) { | ||
exports.compareWithTolerance = compareWithTolerance; | ||
/** @hidden */ | ||
/** @public */ | ||
function compareNumbers(a, b) { return a - b; } | ||
exports.compareNumbers = compareNumbers; | ||
/** @hidden */ | ||
/** @public */ | ||
function compareBooleans(a, b) { return a !== b ? (a < b ? -1 : 1) : 0; } | ||
exports.compareBooleans = compareBooleans; | ||
/** @hidden */ | ||
/** @public */ | ||
function compareStrings(a, b) { return a === b ? 0 : (a < b ? -1 : 1); } | ||
exports.compareStrings = compareStrings; | ||
/** @hidden */ | ||
/** @public */ | ||
function comparePossiblyUndefined(compareDefined, lhs, rhs) { | ||
@@ -42,5 +42,5 @@ if (undefined === lhs) | ||
exports.comparePossiblyUndefined = comparePossiblyUndefined; | ||
/** @hidden */ | ||
/** @public */ | ||
function compareStringsOrUndefined(lhs, rhs) { return comparePossiblyUndefined(compareStrings, lhs, rhs); } | ||
exports.compareStringsOrUndefined = compareStringsOrUndefined; | ||
//# sourceMappingURL=Compare.js.map |
@@ -6,2 +6,3 @@ /** @module Collections */ | ||
* Represents an entry in a [[Dictionary]]. | ||
* @public | ||
*/ | ||
@@ -26,2 +27,3 @@ export interface DictionaryEntry<K, V> { | ||
* most likely of which is that keys will cease to map to the values with which they were initially inserted. | ||
* @public | ||
*/ | ||
@@ -28,0 +30,0 @@ export declare class Dictionary<K, V> implements Iterable<DictionaryEntry<K, V>> { |
@@ -43,2 +43,3 @@ "use strict"; | ||
* most likely of which is that keys will cease to map to the values with which they were initially inserted. | ||
* @public | ||
*/ | ||
@@ -45,0 +46,0 @@ class Dictionary { |
@@ -15,2 +15,3 @@ /** @module Utils */ | ||
* However, always consult the documentation for an IDisposable type to determine under what circumstances you are expected to explicitly dispose of it. | ||
* @public | ||
*/ | ||
@@ -39,2 +40,3 @@ export interface IDisposable { | ||
* @returns undefined | ||
* @public | ||
*/ | ||
@@ -45,2 +47,3 @@ export declare function dispose(disposable?: IDisposable): undefined; | ||
* @returns undefined | ||
* @public | ||
*/ | ||
@@ -52,7 +55,12 @@ export declare function disposeArray(list?: IDisposable[]): undefined; | ||
* disposing the resource). | ||
* @public | ||
*/ | ||
export declare function using<TDisposable extends IDisposable, TResult, TArg = TDisposable>(resources: TDisposable | TDisposable[], func: (...resources: TArg[]) => TResult): TResult; | ||
/** A definition of function which may be called to dispose an object */ | ||
export declare function using<T extends IDisposable, TResult>(resources: T | T[], func: (...r: T[]) => TResult): TResult; | ||
/** A definition of function which may be called to dispose an object | ||
* @public | ||
*/ | ||
export declare type DisposeFunc = () => void; | ||
/** A disposable container of disposable objects. */ | ||
/** A disposable container of disposable objects. | ||
* @public | ||
*/ | ||
export declare class DisposableList implements IDisposable { | ||
@@ -59,0 +67,0 @@ private _disposables; |
@@ -24,2 +24,3 @@ "use strict"; | ||
* @returns undefined | ||
* @public | ||
*/ | ||
@@ -35,2 +36,3 @@ function dispose(disposable) { | ||
* @returns undefined | ||
* @public | ||
*/ | ||
@@ -50,2 +52,3 @@ function disposeArray(list) { | ||
* disposing the resource). | ||
* @public | ||
*/ | ||
@@ -58,4 +61,4 @@ function using(resources, func) { | ||
try { | ||
const result = func.apply(undefined, resources); | ||
if (result && result.then) { | ||
const result = func(...resources); | ||
if (result instanceof Promise) { | ||
shouldDisposeImmediately = false; | ||
@@ -76,3 +79,5 @@ result.then(doDispose, doDispose); | ||
} | ||
/** A disposable container of disposable objects. */ | ||
/** A disposable container of disposable objects. | ||
* @public | ||
*/ | ||
class DisposableList { | ||
@@ -79,0 +84,0 @@ /** Creates a disposable list. */ |
/** @module Ids */ | ||
/** | ||
* A string containing a well-formed string representation of an [Id64]($bentleyjs-core). | ||
* | ||
/** A string containing a well-formed string representation of an [Id64]($bentleyjs-core). | ||
* See [Working with Ids]($docs/learning/common/Id64.md). | ||
* @public | ||
*/ | ||
export declare type Id64String = string; | ||
/** | ||
* A string containing a well-formed string representation of a [Guid]($bentleyjs-core). | ||
/** A string containing a well-formed string representation of a [Guid]($bentleyjs-core). | ||
* @public | ||
*/ | ||
export declare type GuidString = string; | ||
/** A set of [[Id64String]]s. */ | ||
/** A set of [[Id64String]]s. | ||
* @public | ||
*/ | ||
export declare type Id64Set = Set<Id64String>; | ||
/** An array of [[Id64String]]s. */ | ||
/** An array of [[Id64String]]s. | ||
* @public | ||
*/ | ||
export declare type Id64Array = Id64String[]; | ||
/** Used as an argument to a function that can accept one or more [[Id64String]]s. */ | ||
/** Used as an argument to a function that can accept one or more [[Id64String]]s. | ||
* @public | ||
*/ | ||
export declare type Id64Arg = Id64String | Id64Set | Id64Array; | ||
@@ -25,2 +30,3 @@ /** | ||
* See [Working with Ids]($docs/learning/common/Id64.md) for a detailed description and code examples. | ||
* @public | ||
*/ | ||
@@ -131,2 +137,3 @@ export declare namespace Id64 { | ||
* @see [[Id64.Uint32Map]] for a similarly-optimized replacement for Map<Id64String, T> | ||
* @public | ||
*/ | ||
@@ -156,2 +163,3 @@ class Uint32Set { | ||
* @see [[Id64.Uint32Set]] for implementation details. | ||
* @public | ||
*/ | ||
@@ -180,2 +188,3 @@ class Uint32Map<T> { | ||
* A TransientIdSequence can generate a maximum of (2^40)-2 unique Ids. | ||
* @public | ||
*/ | ||
@@ -192,2 +201,3 @@ export declare class TransientIdSequence { | ||
* be in the GUID format. | ||
* @public | ||
*/ | ||
@@ -194,0 +204,0 @@ export declare namespace Guid { |
@@ -39,2 +39,3 @@ "use strict"; | ||
* See [Working with Ids]($docs/learning/common/Id64.md) for a detailed description and code examples. | ||
* @public | ||
*/ | ||
@@ -352,2 +353,3 @@ var Id64; | ||
* @see [[Id64.Uint32Map]] for a similarly-optimized replacement for Map<Id64String, T> | ||
* @public | ||
*/ | ||
@@ -407,2 +409,3 @@ class Uint32Set { | ||
* @see [[Id64.Uint32Set]] for implementation details. | ||
* @public | ||
*/ | ||
@@ -449,2 +452,3 @@ class Uint32Map { | ||
* A TransientIdSequence can generate a maximum of (2^40)-2 unique Ids. | ||
* @public | ||
*/ | ||
@@ -464,2 +468,3 @@ class TransientIdSequence { | ||
* be in the GUID format. | ||
* @public | ||
*/ | ||
@@ -466,0 +471,0 @@ var Guid; |
/** @module Collections */ | ||
import { CloneFunction } from "./SortedArray"; | ||
import { OrderedComparator } from "./Compare"; | ||
/** Associates a value of type T with an index representing its insertion order in an IndexMap<T> */ | ||
/** Associates a value of type T with an index representing its insertion order in an IndexMap<T> | ||
* @public | ||
*/ | ||
export declare class IndexedValue<T> { | ||
@@ -14,2 +16,3 @@ readonly value: T; | ||
* The user may also supply a maximum size, beyond which insertions will fail. | ||
* @public | ||
*/ | ||
@@ -16,0 +19,0 @@ export declare class IndexMap<T> { |
@@ -9,3 +9,5 @@ "use strict"; | ||
const SortedArray_1 = require("./SortedArray"); | ||
/** Associates a value of type T with an index representing its insertion order in an IndexMap<T> */ | ||
/** Associates a value of type T with an index representing its insertion order in an IndexMap<T> | ||
* @public | ||
*/ | ||
class IndexedValue { | ||
@@ -22,2 +24,3 @@ constructor(value, index) { | ||
* The user may also supply a maximum size, beyond which insertions will fail. | ||
* @public | ||
*/ | ||
@@ -24,0 +27,0 @@ class IndexMap { |
/** @module Utils */ | ||
/** Utility functions for converting from JSON objects, with default values. */ | ||
/** Utility functions for converting from JSON objects, with default values. | ||
* @public | ||
*/ | ||
export declare namespace JsonUtils { | ||
@@ -4,0 +6,0 @@ /** Get a value as a boolean. |
@@ -8,3 +8,5 @@ "use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
/** Utility functions for converting from JSON objects, with default values. */ | ||
/** Utility functions for converting from JSON objects, with default values. | ||
* @public | ||
*/ | ||
var JsonUtils; | ||
@@ -11,0 +13,0 @@ (function (JsonUtils) { |
/** @module Logging */ | ||
import { GetMetaDataFunction } from "./BentleyError"; | ||
import { IDisposable } from "./Disposable"; | ||
/** Defines the *signature* for a log function. */ | ||
/** Defines the *signature* for a log function. | ||
* @public | ||
*/ | ||
export declare type LogFunction = (category: string, message: string, metaData?: GetMetaDataFunction) => void; | ||
/** Use to categorize logging messages by severity. | ||
* @public | ||
*/ | ||
export declare enum LogLevel { | ||
@@ -18,3 +23,5 @@ /** Tracing and debugging - low level */ | ||
} | ||
/** Identifies a logging category and the LogLevel that should be used for it. The LogLevel is specified by its string name. */ | ||
/** Identifies a logging category and the LogLevel that should be used for it. The LogLevel is specified by its string name. | ||
* @public | ||
*/ | ||
export interface LoggerCategoryAndLevel { | ||
@@ -24,3 +31,5 @@ category: string; | ||
} | ||
/** Specifies logging levels, including the default logging level and a set of categories and levels for them. */ | ||
/** Specifies logging levels, including the default logging level and a set of categories and levels for them. | ||
* @public | ||
*/ | ||
export interface LoggerLevelsConfig { | ||
@@ -32,2 +41,3 @@ defaultLevel?: string; | ||
* how or if the logged information is displayed or collected. See [Learning about Logging]($docs/learning/common/Logging.md). | ||
* @public | ||
*/ | ||
@@ -121,2 +131,3 @@ export declare class Logger { | ||
* Enable those, if you want to capture timings. | ||
* @public | ||
*/ | ||
@@ -131,3 +142,5 @@ export declare class PerfLogger implements IDisposable { | ||
} | ||
/** Helps with macro-substitution */ | ||
/** Helps with macro-substitution | ||
* @alpha Better name? | ||
*/ | ||
export declare class EnvMacroSubst { | ||
@@ -134,0 +147,0 @@ /** Replace macros delimited by ${} assuming that they refer to environment variables. */ |
@@ -10,2 +10,5 @@ "use strict"; | ||
const ActivityLoggingContext_1 = require("./ActivityLoggingContext"); | ||
/** Use to categorize logging messages by severity. | ||
* @public | ||
*/ | ||
var LogLevel; | ||
@@ -26,2 +29,3 @@ (function (LogLevel) { | ||
* how or if the logged information is displayed or collected. See [Learning about Logging]($docs/learning/common/Logging.md). | ||
* @public | ||
*/ | ||
@@ -233,2 +237,3 @@ class Logger { | ||
* Enable those, if you want to capture timings. | ||
* @public | ||
*/ | ||
@@ -255,3 +260,5 @@ class PerfLogger { | ||
exports.PerfLogger = PerfLogger; | ||
/** Helps with macro-substitution */ | ||
/** Helps with macro-substitution | ||
* @alpha Better name? | ||
*/ | ||
class EnvMacroSubst { | ||
@@ -258,0 +265,0 @@ /** Replace macros delimited by ${} assuming that they refer to environment variables. */ |
/** @module Collections */ | ||
/** An entry holds the key and value, and pointers to any older and newer entries. */ | ||
/** An entry holds the key and value, and pointers to any older and newer entries. | ||
* @public | ||
*/ | ||
export declare class Entry<K, V> { | ||
@@ -28,2 +30,3 @@ key: K; | ||
* ``` | ||
* @public | ||
*/ | ||
@@ -30,0 +33,0 @@ export declare class LRUMap<K, V> { |
@@ -13,3 +13,5 @@ "use strict"; | ||
*/ | ||
/** An entry holds the key and value, and pointers to any older and newer entries. */ | ||
/** An entry holds the key and value, and pointers to any older and newer entries. | ||
* @public | ||
*/ | ||
class Entry { | ||
@@ -77,2 +79,3 @@ constructor(key, value) { | ||
* ``` | ||
* @public | ||
*/ | ||
@@ -79,0 +82,0 @@ class LRUMap { |
/** @module Collections */ | ||
import { CloneFunction } from "./SortedArray"; | ||
import { OrderedComparator } from "./Compare"; | ||
/** @public */ | ||
export declare type ComputePriorityFunction<T> = (value: T) => number; | ||
@@ -8,2 +9,3 @@ /** | ||
* The queue is ordered by an [[OrderedComparator]] function supplied by the user such that the value in the queue that compares less than all other values is always located at the front of the queue. | ||
* @public | ||
*/ | ||
@@ -10,0 +12,0 @@ export declare class PriorityQueue<T> implements Iterable<T> { |
@@ -12,2 +12,3 @@ "use strict"; | ||
* The queue is ordered by an [[OrderedComparator]] function supplied by the user such that the value in the queue that compares less than all other values is always located at the front of the queue. | ||
* @public | ||
*/ | ||
@@ -14,0 +15,0 @@ class PriorityQueue { |
@@ -6,2 +6,3 @@ /** @module Collections */ | ||
* It is up to the function to decide how deeply or shallowly the value is cloned. For example, [[shallowClone]] simply returns the input. | ||
* @public | ||
*/ | ||
@@ -14,2 +15,3 @@ export declare type CloneFunction<T> = (value: T) => T; | ||
* @returns the input value. | ||
* @public | ||
*/ | ||
@@ -23,2 +25,3 @@ export declare function shallowClone<T>(value: T): T; | ||
* @returns an object with 'index' corresponding to the computed position and 'equal' set to true if an equivalent element already exists at that index. | ||
* @public | ||
*/ | ||
@@ -52,2 +55,3 @@ export declare function lowerBound<T, U = T>(value: T, list: U[], compare: OrderedComparator<T, U>): { | ||
* most likely of which is that the array will cease to be sorted. | ||
* @public | ||
*/ | ||
@@ -54,0 +58,0 @@ export declare class SortedArray<T> implements Iterable<T> { |
@@ -13,2 +13,3 @@ "use strict"; | ||
* @returns the input value. | ||
* @public | ||
*/ | ||
@@ -23,2 +24,3 @@ function shallowClone(value) { return value; } | ||
* @returns an object with 'index' corresponding to the computed position and 'equal' set to true if an equivalent element already exists at that index. | ||
* @public | ||
*/ | ||
@@ -64,2 +66,3 @@ function lowerBound(value, list, compare) { | ||
* most likely of which is that the array will cease to be sorted. | ||
* @public | ||
*/ | ||
@@ -66,0 +69,0 @@ class SortedArray { |
@@ -5,2 +5,3 @@ /** @module Utils */ | ||
* @returns An equivalent string, or undefined if the array does not contain a valid utf-8 string. | ||
* @public | ||
*/ | ||
@@ -12,4 +13,5 @@ export declare function utf8ToString(utf8: Uint8Array): string | undefined; | ||
* @throws DOMException if the length of the input string is not a multiple of 4. | ||
* @public | ||
*/ | ||
export declare function base64StringToUint8Array(base64: string): Uint8Array; | ||
//# sourceMappingURL=StringUtils.d.ts.map |
@@ -12,3 +12,3 @@ "use strict"; | ||
// which is itself inspired by https://github.com/inexorabletash/text-encoding | ||
// @hidden | ||
/** @internal */ | ||
var Utf8ToString; | ||
@@ -107,2 +107,3 @@ (function (Utf8ToString) { | ||
* @returns An equivalent string, or undefined if the array does not contain a valid utf-8 string. | ||
* @public | ||
*/ | ||
@@ -119,2 +120,3 @@ function utf8ToString(utf8) { | ||
* @throws DOMException if the length of the input string is not a multiple of 4. | ||
* @public | ||
*/ | ||
@@ -121,0 +123,0 @@ function base64StringToUint8Array(base64) { |
/** @module Utils */ | ||
/** A duration of time. Can be either positive (towards future) or negative (in the past). | ||
* BeDurations are immutable. | ||
* @public | ||
*/ | ||
@@ -38,2 +39,3 @@ export declare class BeDuration { | ||
* BeTimePoints are immutable. | ||
* @public | ||
*/ | ||
@@ -76,3 +78,5 @@ export declare class BeTimePoint { | ||
} | ||
/** A StopWatch for timing operations. */ | ||
/** A StopWatch for timing operations. | ||
* @public | ||
*/ | ||
export declare class StopWatch { | ||
@@ -79,0 +83,0 @@ description?: string | undefined; |
@@ -10,2 +10,3 @@ "use strict"; | ||
* BeDurations are immutable. | ||
* @public | ||
*/ | ||
@@ -47,2 +48,3 @@ class BeDuration { | ||
* BeTimePoints are immutable. | ||
* @public | ||
*/ | ||
@@ -85,3 +87,5 @@ class BeTimePoint { | ||
exports.BeTimePoint = BeTimePoint; | ||
/** A StopWatch for timing operations. */ | ||
/** A StopWatch for timing operations. | ||
* @public | ||
*/ | ||
class StopWatch { | ||
@@ -88,0 +92,0 @@ /** ctor for StopWatch |
{ | ||
"name": "@bentley/bentleyjs-core", | ||
"version": "0.187.0", | ||
"version": "0.189.0", | ||
"description": "Bentley JavaScript core components", | ||
@@ -13,4 +13,5 @@ "main": "lib/bentleyjs-core.js", | ||
"scripts": { | ||
"build": "tsc 1>&2 && npm run webpackModule-dev", | ||
"build": "node ./node_modules/@bentley/webpack-tools/bin/buildIModelJsModule.js", | ||
"clean": "rimraf lib package-deps.json", | ||
"extract-api": "node ./node_modules/@bentley/build-tools/scripts/extract-api.js --entry=bentleyjs-core", | ||
"test": "node ./node_modules/@bentley/build-tools/scripts/test.js", | ||
@@ -20,6 +21,14 @@ "docs": "node ./node_modules/@bentley/build-tools/scripts/docs.js --source=./src --json=../../generated-docs/core/bentleyjs-core/file.json --tsIndexFile=bentleyjs-core.ts --onlyJson %TYPEDOC_THEME%", | ||
"cover:docs": "node ./node_modules/@bentley/build-tools/scripts/docscoverage.js", | ||
"lint": "tslint --project . 1>&2", | ||
"webpackModule-dev": "make-dir ./lib/module/dev/ && webpack --config ./node_modules/@bentley/webpack-tools/modules/webpackModule.config.js --env.entry=./lib/bentleyjs-core.js --env.bundlename=bentleyjs-core --json >./lib/module/dev/webpackStats.json", | ||
"webpackModule-prod": "webpack --config ./node_modules/@bentley/webpack-tools/modules/webpackModule.config.js --env.entry=./lib/bentleyjs-core.js --env.bundlename=bentleyjs-core --env.prod" | ||
"lint": "tslint --project . 1>&2" | ||
}, | ||
"iModelJs": { | ||
"buildModule": { | ||
"type": "system", | ||
"webpack": { | ||
"dest": "./lib/module", | ||
"entry": "./lib/bentleyjs-core.js", | ||
"bundleName": "bentleyjs-core" | ||
} | ||
} | ||
}, | ||
"keywords": [ | ||
@@ -35,9 +44,8 @@ "Bentley", | ||
"devDependencies": { | ||
"@bentley/build-tools": "0.187.0", | ||
"@bentley/webpack-tools": "0.187.0", | ||
"@bentley/build-tools": "0.189.0", | ||
"@bentley/webpack-tools": "0.189.0", | ||
"@types/chai": "^4.1.4", | ||
"@types/mocha": "^5.2.5", | ||
"@types/node": "10.10.3", | ||
"@types/node": "10.12.18", | ||
"chai": "^4.1.2", | ||
"make-dir-cli": "^1.0.0", | ||
"mocha": "^5.2.0", | ||
@@ -47,10 +55,5 @@ "rimraf": "^2.6.2", | ||
"typedoc": "^0.11.1", | ||
"typedoc-plugin-external-module-name": "^1.1.1", | ||
"typescript": "~3.1.0", | ||
"typescript": "~3.2.2", | ||
"ts-node": "^7.0.1", | ||
"nyc": "^13.0.1", | ||
"source-map-loader": "^0.2.3", | ||
"source-map-support": "^0.5.6", | ||
"webpack": "^4.20.2", | ||
"webpack-cli": "^3.1.0" | ||
"nyc": "^13.0.1" | ||
}, | ||
@@ -57,0 +60,0 @@ "nyc": { |
Sorry, the diff of this file is too big to display
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
13
454247
44
9018