Skip to content

Commit

Permalink
Merge pull request #1305 from remotestorage/docs/1303-code_overview_f…
Browse files Browse the repository at this point in the history
…ilenames

Fix filenames .js -> .ts in code overview
  • Loading branch information
raucao committed Jan 16, 2024
2 parents 7fcafd4 + 43847e9 commit 12384cb
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/contributing/code-overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ repo. These are built into a single file in the ``release/`` folder using
and are based on `Jaribu <https://github.com/silverbucket/jaribu>`_.

The structure of the code is based around feature loading. Most files in
``src/`` correspond to a feature, e.g. ``discover.js`` to
``RemoteStorage.Discover`` or ``caching.js`` to ``RemoteStorage.Caching``.
``src/`` correspond to a feature, e.g. ``discover.ts`` to
``RemoteStorage.Discover`` or ``caching.ts`` to ``RemoteStorage.Caching``.

The feature loading happens synchronously during the page load in
``src/remotestorage.js`` (just including this script in your app will lead to
``src/remotestorage.ts`` (just including this script in your app will lead to
executing the code that loads the features).

Most features load under their own name, but for ``remoteStorage.local`` a
Expand All @@ -22,7 +22,7 @@ supports.

For ``remoteStorage.local`` we then also have a `special mixin
<https://github.com/remotestorage/remotestorage.js/issues/777#issuecomment-57392440>`__
called ``src/cachinglayer.js``, which mixes in some common functions into the
called ``src/cachinglayer.ts``, which mixes in some common functions into the
object.

The ``remoteStorage.remote`` feature is not loaded immediately, but only when
Expand Down

0 comments on commit 12384cb

Please sign in to comment.