Lightning Components Developer Guide

What is the Lightning Component Framework?
Quick Start
Creating Components
Using Components
Communicating with Events
Creating Apps
App Overview
Designing App UI
Creating App Templates
Developing Secure Code
Content Security Policy Overview
LockerService Rules for Writing Secure Code
Salesforce Lightning CLI
Install Salesforce Lightning CLI
Use Salesforce Lightning CLI
Review and Resolve Problems
Salesforce Lightning CLI Rules
Validate JavaScript Intrinsic APIs (ecma-intrinsics)
Disallow instanceof (no-instanceof)
Validate Aura API (aura-api)
Validate Lightning Component Public API (secure-component)
Validate Secure Document Public API (secure-document)
Validate Secure Window Public API (secure-window)
Custom “House Style” Rules
Salesforce Lightning CLI Options
Styling Apps
Using JavaScript
JavaScript Cookbook
Using Apex
Controlling Access
Using Object-Oriented Development
Caching with Storage Service
Using the AppCache
Distributing Applications and Components
Debugging
Reference
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Validate Aura API (aura-api)

This rule verifies that use of the framework APIs is according to the published documentation. The use of undocumented or private features is disallowed.
When LockerService is enabled, the framework prevents the use of unsupported API objects or calls. That means your Lightning components code is allowed to use:
  • Features built into JavaScript (“intrinsic” features)
  • Published, supported features built into the Lightning Component framework
  • Published, supported features built into LockerService SecureObject objects

This rule deals with the supported, public framework APIs, for example, those available through the framework global $A.

Why is this rule called “Aura API”? Because the core of the the Lightning Component framework is the open source Aura Framework. And this rule verifies permitted uses of that framework, rather than anything specific to Lightning Components.

Rule Details

The following patterns are considered problematic:
1Aura.something(); // Use $A instead
2$A.util.fake(); // fake is not available in $A.util

Further Reading

For details of all of the methods available in the framework, including $A, see the JavaScript API at https://myDomain.lightning.force.com/auradocs/reference.app, where myDomain is the name of your custom Salesforce domain.