Skip to content
This repository was archived by the owner on Feb 4, 2018. It is now read-only.

Commit 86e59d2

Browse files
author
blond
committed
refactor(typings): rename global namespace to BEMSDK
1 parent 0ba2093 commit 86e59d2

File tree

4 files changed

+24
-24
lines changed

4 files changed

+24
-24
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -393,7 +393,7 @@ TypeScript support
393393

394394
The package includes [typings](./index.d.ts) for TypeScript. You have to set up transpilation yourself. When you set `module` to `commonjs` in your `tsconfig.json` file, TypeScript will automatically find the type definitions for `@bem/entity-name`.
395395

396-
The interfaces are provided in global namespace `BemSDK.EntityName`. It is necessary to use interfaces in JsDoc.
396+
The interfaces are provided in global namespace `BEMSDK.EntityName`. It is necessary to use interfaces in JsDoc.
397397

398398
Debuggability
399399
-------------

globals.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
declare namespace BemSDK {
1+
declare namespace BEMSDK {
22
export namespace EntityName {
33
/**
44
* Types of BEM entities.

index.d.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,26 @@
11
import './globals.d';
22

33
declare class BemEntityName {
4-
constructor(obj: BemSDK.EntityName.Options);
4+
constructor(obj: BEMSDK.EntityName.Options);
55

6-
readonly block: BemSDK.EntityName.BlockName;
7-
readonly elem: BemSDK.EntityName.ElementName | undefined;
8-
readonly mod: BemSDK.EntityName.Modifier | undefined;
9-
readonly modName: BemSDK.EntityName.ModifierName | undefined;
10-
readonly modVal: BemSDK.EntityName.ModifierValue | undefined;
11-
readonly type: BemSDK.EntityName.Type;
6+
readonly block: BEMSDK.EntityName.BlockName;
7+
readonly elem: BEMSDK.EntityName.ElementName | undefined;
8+
readonly mod: BEMSDK.EntityName.Modifier | undefined;
9+
readonly modName: BEMSDK.EntityName.ModifierName | undefined;
10+
readonly modVal: BEMSDK.EntityName.ModifierValue | undefined;
11+
readonly type: BEMSDK.EntityName.Type;
1212
readonly scope: BemEntityName | null;
13-
readonly id: BemSDK.EntityName.Id;
13+
readonly id: BEMSDK.EntityName.Id;
1414

1515
isSimpleMod(): boolean | null;
1616
isEqual(entityName: BemEntityName): boolean;
1717
belongsTo(entityName: BemEntityName): boolean;
18-
valueOf(): BemSDK.EntityName.Representation;
19-
toJSON(): BemSDK.EntityName.Representation;
18+
valueOf(): BEMSDK.EntityName.Representation;
19+
toJSON(): BEMSDK.EntityName.Representation;
2020
toString(): string;
2121
inspect(depth: number, options: object): string;
2222

23-
static create(obj: BemSDK.EntityName.CreateOptions | string): BemEntityName;
23+
static create(obj: BEMSDK.EntityName.CreateOptions | string): BemEntityName;
2424
static isBemEntityName(entityName: any): boolean;
2525
}
2626

lib/entity-name.js

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ const TYPES = {
2222

2323
class BemEntityName {
2424
/**
25-
* @param {BemSDK.EntityName.Options} obj — representation of entity name.
25+
* @param {BEMSDK.EntityName.Options} obj — representation of entity name.
2626
*/
2727
constructor(obj) {
2828
if (!obj.block) {
@@ -61,7 +61,7 @@ class BemEntityName {
6161
*
6262
* name.block; // button
6363
*
64-
* @returns {BemSDK.EntityName.BlockName} name of entity block.
64+
* @returns {BEMSDK.EntityName.BlockName} name of entity block.
6565
*/
6666
get block() { return this._data.block; }
6767

@@ -76,7 +76,7 @@ class BemEntityName {
7676
*
7777
* name.elem; // text
7878
*
79-
* @returns {?BemSDK.EntityName.ElementName} - name of entity element.
79+
* @returns {?BEMSDK.EntityName.ElementName} - name of entity element.
8080
*/
8181
get elem() { return this._data.elem; }
8282

@@ -94,7 +94,7 @@ class BemEntityName {
9494
* modName.mod; // { name: 'disabled', val: true }
9595
* blockName.mod; // undefined
9696
*
97-
* @returns {?BemSDK.EntityName.Modifier} - entity modifier.
97+
* @returns {?BEMSDK.EntityName.Modifier} - entity modifier.
9898
*/
9999
get mod() { return this._data.mod; }
100100

@@ -103,7 +103,7 @@ class BemEntityName {
103103
*
104104
* If entity is not modifier then returns `undefined`.
105105
*
106-
* @returns {?BemSDK.EntityName.ModifierName} - entity modifier name.
106+
* @returns {?BEMSDK.EntityName.ModifierName} - entity modifier name.
107107
* @deprecated use {@link BemEntityName#mod.name}
108108
*/
109109
get modName() {
@@ -117,7 +117,7 @@ class BemEntityName {
117117
*
118118
* If entity is not modifier then returns `undefined`.
119119
*
120-
* @returns {?BemSDK.EntityName.ModifierValue} - entity modifier name.
120+
* @returns {?BEMSDK.EntityName.ModifierValue} - entity modifier name.
121121
* @deprecated use {@link BemEntityName#mod.val}
122122
*/
123123
get modVal() {
@@ -141,7 +141,7 @@ class BemEntityName {
141141
*
142142
* name.type; // elemMod
143143
*
144-
* @returns {BemSDK.EntityName.Type} - type of entity.
144+
* @returns {BEMSDK.EntityName.Type} - type of entity.
145145
*/
146146
get type() {
147147
if (this._type) { return this._type; }
@@ -200,7 +200,7 @@ class BemEntityName {
200200
*
201201
* name.id; // button_disabled
202202
*
203-
* @returns {BemSDK.EntityName.Id} - id of entity.
203+
* @returns {BEMSDK.EntityName.Id} - id of entity.
204204
*/
205205
get id() {
206206
if (this._id) { return this._id; }
@@ -300,7 +300,7 @@ class BemEntityName {
300300
*
301301
* // ➜ { block: 'button', mod: { name: 'focused', value: true } }
302302
*
303-
* @returns {BemSDK.EntityName.Representation}
303+
* @returns {BEMSDK.EntityName.Representation}
304304
*/
305305
valueOf() { return this._data; }
306306

@@ -314,7 +314,7 @@ class BemEntityName {
314314
*
315315
* JSON.stringify(name); // {"block":"input","mod":{"name":"available","val":true}}
316316
*
317-
* @returns {BemSDK.EntityName.Representation}
317+
* @returns {BEMSDK.EntityName.Representation}
318318
*/
319319
toJSON() {
320320
return this._data;
@@ -373,7 +373,7 @@ class BemEntityName {
373373
* BemEntityName.create({ block: 'my-button', modName: 'theme', modVal: 'red' });
374374
* // → BemEntityName { block: 'my-button', mod: { name: 'theme', val: 'red' } }
375375
*
376-
* @param {(BemSDK.EntityName.CreateOptions|string)} obj — representation of entity name.
376+
* @param {(BEMSDK.EntityName.CreateOptions|string)} obj — representation of entity name.
377377
* @returns {BemEntityName} An object representing entity name.
378378
*/
379379
static create(obj) {

0 commit comments

Comments
 (0)