feat: add .parentCustomEntity() API to .tokens() API

Author: sanjayaksaxena

src/doc-v2.js

@@ -154,6 +154,8 @@ var doc = function ( docData, wordVectors ) {
     api.parentDocument = () => methods;
     // Access the parent entity, **if any.**
     api.parentEntity = () => getParentItem( index, entities, itemEntity );
+    // Access the parent cuustom entity, **if any.**
+    api.parentCustomEntity = () => getParentItem( index, customEntities, itemCustomEntity );
     // Markup this token.
     api.markup = ( beginMarker, endMarker ) => markings.push( [ index, index, beginMarker, endMarker ] );
     // Output this token or its properties using mapper function — `f`.

test/custom-entities-specs.js

@@ -205,4 +205,21 @@ describe( 'Detect from learned examples', function () {
     var d1 = nlp0.readDoc( 'I am a literal!' );
     expect( d1.customEntities().out( its.detail ) ).to.deep.equal( [] );
   } );
+
+  it( '.parentCustomEntity() must work correctly', function () {
+    const config = { matchValue: false, usePOS: false, useEntity: true };
+    const expectedEntities = [
+      { value: '[email protected]:-)', type: 'email-emoticon' },
+      { value: '^', type: 'caret' },
+      { value: 'thin', type: 'crust-type' },
+      { value: 'ADJ Parrot', type: 'escaped-adj-parrot' },
+      { value: '$5', type: 'entity-money' },
+      { value: '^ carrot', type: 'caret-carrot' }
+    ];
+    nlp.learnCustomEntities( examples, config );
+    var d1 = nlp.readDoc( s1 );
+    expect( d1.tokens().itemAt( 0 ).parentCustomEntity().out( its.detail ) ).to.deep.equal( expectedEntities[ 0 ] );
+    expect( d1.tokens().itemAt( 2 ).parentCustomEntity() ).to.deep.equal( undefined );
+    expect( d1.tokens().itemAt( 22 ).parentCustomEntity().out( its.detail ) ).to.deep.equal( expectedEntities[ 5 ] );
+  } );
 } );